From 0f735413a8df86118507e7ae45606762a98e2776 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Tue, 29 Aug 2023 00:22:26 -0500 Subject: [PATCH] [RND-623] initial matchup to MetaEd api-schema plugin --- .../integration/QueryElasticsearch.test.ts | 6 +- .../src/model/MeadowlarkDocument.ts | 4 +- .../integration/OwnershipSecurity.test.ts | 4 +- .../integration/SecurityMiddleware.test.ts | 4 +- .../middleware/SecurityMiddleware.test.ts | 11 +- .../test/integration/QueryOpensearch.test.ts | 6 +- .../integration/OwnershipSecurity.test.ts | 4 +- .../integration/SecurityMiddleware.test.ts | 4 +- Meadowlark-js/package-lock.json | 496 +- .../packages/meadowlark-core/package.json | 8 +- .../packages/meadowlark-core/src/Constants.ts | 8 - .../packages/meadowlark-core/src/Logger.ts | 21 +- .../src/api-schema/ProjectSchemaFinder.ts | 112 + .../src/api-schema/ResourceSchemaFinder.ts | 25 + .../src/ds-schemas/DataStandard-3.3.1-b.json | 73015 +++++++++++++++ .../ds-schemas/DataStandard-5.0.0-pre.1.json | 73500 ++++++++++++++++ .../extraction/DocumentIdentityExtractor.ts | 92 - .../DocumentIdentityExtractor.ts.old | 166 + .../meadowlark-core/src/handler/Delete.ts | 13 +- .../src/handler/FrontendFacade.ts | 23 +- .../src/handler/FrontendRequest.ts | 42 +- .../meadowlark-core/src/handler/GetById.ts | 8 +- .../src/handler/MetadataHandler.ts | 8 +- .../meadowlark-core/src/handler/Query.ts | 17 +- .../meadowlark-core/src/handler/Update.ts | 18 +- .../meadowlark-core/src/handler/Upsert.ts | 10 +- .../meadowlark-core/src/handler/UriBuilder.ts | 10 +- .../packages/meadowlark-core/src/index.ts | 9 +- .../meadowlark-core/src/metaed/LoadMetaEd.ts | 101 - .../src/metaed/MetaEdModelFinder.ts | 22 - .../src/metaed/MetaEdProjectMetadata.ts | 138 - .../src/metaed/MetaEdValidation.ts | 179 - .../src/metaed/ResourceNameMapping.ts | 136 - .../src/middleware/AuthorizationMiddleware.ts | 16 +- .../ExtractDocumentInfoMiddleware.ts | 2 +- .../middleware/FindMetaEdModelMiddleware.ts | 39 - .../src/middleware/ParseBodyMiddleware.ts | 4 +- .../src/middleware/ParsePathMiddleware.ts | 17 +- .../middleware/ResponseLoggingMiddleware.ts | 9 +- .../middleware/TimestampRequestMiddleware.ts | 7 +- .../middleware/ValidateDocumentMiddleware.ts | 8 +- ...eware.ts => ValidateEndpointMiddleware.ts} | 20 +- .../ValidateEqualityConstraintMiddleware.ts | 6 +- .../src/middleware/ValidateQueryMiddleware.ts | 2 +- .../meadowlark-core/src/model/BrandType.ts | 9 + .../src/model/DocumentIdentity.ts | 7 +- .../meadowlark-core/src/model/IdTypes.ts | 5 +- .../src/model/PathComponents.ts | 37 +- .../src/model/ProjectShortVersion.ts | 12 + .../meadowlark-core/src/model/ResourceInfo.ts | 7 +- .../src/model/ResourceMatchResult.ts | 36 - .../src/model/api-schema/ApiSchema.ts | 20 + .../src/model/api-schema/DocumentObjectKey.ts | 11 + .../src/model/api-schema/DocumentPaths.ts | 71 + .../model/api-schema/DocumentPathsMapping.ts | 11 + .../src/model/api-schema/EndpointName.ts | 14 + .../model/api-schema/EqualityConstraint.ts | 14 + .../src/model/api-schema/JsonPath.ts | 8 + .../src/model/api-schema/JsonSchema.ts | 63 + .../src/model/api-schema/MetaEdProjectName.ts | 12 + .../api-schema/MetaEdPropertyFullName.ts | 13 + .../model/api-schema/MetaEdPropertyPath.ts | 13 + .../model/api-schema/MetaEdResourceName.ts | 14 + .../src/model/api-schema/ProjectNamespace.ts | 12 + .../src/model/api-schema/ProjectSchema.ts | 39 + .../model/api-schema/ProjectSchemaMapping.ts | 14 + .../src/model/api-schema/ResourceSchema.ts | 121 + .../model/api-schema/ResourceSchemaMapping.ts | 14 + .../src/model/api-schema/SemVer.ts | 13 + .../src/validation/DocumentValidator.ts | 32 +- .../validation/EndpointValidationResult.ts | 27 + .../src/validation/EndpointValidator.ts | 96 + .../validation/EqualityConstraintValidator.ts | 10 +- .../src/validation/QueryStringValidator.ts | 62 +- .../validation/ResourceSchemaValidation.ts | 50 + .../src/validation/ResourceValidator.ts | 92 - .../test/handler/DeleteIt.test.ts | 9 +- .../test/handler/GetById.test.ts | 9 +- .../test/handler/Query.test.ts | 9 +- .../test/handler/Update.test.ts | 9 +- .../test/handler/Upsert.test.ts | 9 +- .../test/metaed/ResourceNameMapping.test.ts | 271 - .../FindMetaEdModelMiddleware.test.ts | 107 - .../ValidateDocumentMiddleware.test.ts | 4 +- ....ts => ValidateEndpointMiddleware.test.ts} | 53 +- .../test/validation/DocumentValidator.test.ts | 70 - .../EqualityConstraintValidator.test.ts | 2 +- .../tests/e2e/setup/SetupTestEnvironment.ts | 6 +- .../e2e/setup/TeardownTestEnvironment.ts | 5 +- 89 files changed, 148120 insertions(+), 1752 deletions(-) create mode 100644 Meadowlark-js/packages/meadowlark-core/src/api-schema/ProjectSchemaFinder.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/api-schema/ResourceSchemaFinder.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-3.3.1-b.json create mode 100644 Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-5.0.0-pre.1.json create mode 100644 Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts.old delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/metaed/LoadMetaEd.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdModelFinder.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdProjectMetadata.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdValidation.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/metaed/ResourceNameMapping.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/middleware/FindMetaEdModelMiddleware.ts rename Meadowlark-js/packages/meadowlark-core/src/middleware/{ValidateResourceMiddleware.ts => ValidateEndpointMiddleware.ts} (63%) create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/BrandType.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/ProjectShortVersion.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/ResourceMatchResult.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ApiSchema.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentObjectKey.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPaths.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPathsMapping.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EndpointName.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EqualityConstraint.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonPath.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonSchema.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdProjectName.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyFullName.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyPath.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdResourceName.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectNamespace.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchema.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchemaMapping.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchema.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchemaMapping.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/model/api-schema/SemVer.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidationResult.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidator.ts create mode 100644 Meadowlark-js/packages/meadowlark-core/src/validation/ResourceSchemaValidation.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/src/validation/ResourceValidator.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/test/metaed/ResourceNameMapping.test.ts delete mode 100644 Meadowlark-js/packages/meadowlark-core/test/middleware/FindMetaEdModelMiddleware.test.ts rename Meadowlark-js/packages/meadowlark-core/test/middleware/{ValidateResourceMiddleware.test.ts => ValidateEndpointMiddleware.test.ts} (77%) delete mode 100644 Meadowlark-js/packages/meadowlark-core/test/validation/DocumentValidator.test.ts diff --git a/Meadowlark-js/backends/meadowlark-elasticsearch-backend/test/integration/QueryElasticsearch.test.ts b/Meadowlark-js/backends/meadowlark-elasticsearch-backend/test/integration/QueryElasticsearch.test.ts index 20a81bac..519f318e 100644 --- a/Meadowlark-js/backends/meadowlark-elasticsearch-backend/test/integration/QueryElasticsearch.test.ts +++ b/Meadowlark-js/backends/meadowlark-elasticsearch-backend/test/integration/QueryElasticsearch.test.ts @@ -14,9 +14,11 @@ import { AuthorizationStrategy, DeleteRequest, DeleteResult, + generateDocumentUuid, + DocumentUuid, + MeadowlarkId, + TraceId, } from '@edfi/meadowlark-core'; -import { DocumentUuid, MeadowlarkId, TraceId } from '@edfi/meadowlark-core/src/model/IdTypes'; -import { generateDocumentUuid } from '@edfi/meadowlark-core/src/model/DocumentIdentity'; import { Client } from '@elastic/elasticsearch'; import { queryDocuments } from '../../src/repository/QueryElasticsearch'; import { afterDeleteDocumentById, afterUpsertDocument } from '../../src/repository/UpdateElasticsearch'; diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/src/model/MeadowlarkDocument.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/src/model/MeadowlarkDocument.ts index 3d8c55b8..eb9313be 100644 --- a/Meadowlark-js/backends/meadowlark-mongodb-backend/src/model/MeadowlarkDocument.ts +++ b/Meadowlark-js/backends/meadowlark-mongodb-backend/src/model/MeadowlarkDocument.ts @@ -96,12 +96,12 @@ export interface MeadowlarkDocument extends MeadowlarkDocumentId { createdBy: string; /* - * Creation date as as Unix timestamp, or null if this is a document to be updated and we don't know the create time yet + * Creation date as a Unix timestamp, or null if this is a document to be updated and we don't know the create time yet */ createdAt: number | null; /* - * Last modified date as as Unix timestamp. + * Last modified date as a Unix timestamp. */ lastModifiedAt: number; diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/OwnershipSecurity.test.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/OwnershipSecurity.test.ts index c15d021d..2d944b4e 100644 --- a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/OwnershipSecurity.test.ts +++ b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/OwnershipSecurity.test.ts @@ -17,9 +17,9 @@ import { UpsertRequest, TraceId, UpsertResult, + newFrontendRequestMiddleware, + newPathComponents, } from '@edfi/meadowlark-core'; -import { newFrontendRequestMiddleware } from '@edfi/meadowlark-core/src/handler/FrontendRequest'; -import { newPathComponents } from '@edfi/meadowlark-core/src/model/PathComponents'; import { MongoClient } from 'mongodb'; import { getDocumentCollection, getNewClient } from '../../src/repository/Db'; import { rejectByOwnershipSecurity } from '../../src/repository/OwnershipSecurity'; diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/SecurityMiddleware.test.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/SecurityMiddleware.test.ts index f91cf219..22d36974 100644 --- a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/SecurityMiddleware.test.ts +++ b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/integration/SecurityMiddleware.test.ts @@ -17,9 +17,9 @@ import { UpsertRequest, TraceId, UpsertResult, + newFrontendRequestMiddleware, + newPathComponents, } from '@edfi/meadowlark-core'; -import { newFrontendRequestMiddleware } from '@edfi/meadowlark-core/src/handler/FrontendRequest'; -import { newPathComponents } from '@edfi/meadowlark-core/src/model/PathComponents'; import { MongoClient } from 'mongodb'; import { getDocumentCollection, getNewClient } from '../../src/repository/Db'; import { securityMiddleware } from '../../src/security/SecurityMiddleware'; diff --git a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/middleware/SecurityMiddleware.test.ts b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/middleware/SecurityMiddleware.test.ts index f49cb24f..923c7c1d 100644 --- a/Meadowlark-js/backends/meadowlark-mongodb-backend/test/middleware/SecurityMiddleware.test.ts +++ b/Meadowlark-js/backends/meadowlark-mongodb-backend/test/middleware/SecurityMiddleware.test.ts @@ -3,9 +3,14 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import { FrontendRequest, FrontendResponse, newFrontendRequest, newFrontendResponseSuccess } from '@edfi/meadowlark-core'; -import { newFrontendRequestMiddleware } from '@edfi/meadowlark-core/src/handler/FrontendRequest'; -import { newPathComponents } from '@edfi/meadowlark-core/src/model/PathComponents'; +import { + FrontendRequest, + FrontendResponse, + newFrontendRequest, + newFrontendResponseSuccess, + newFrontendRequestMiddleware, + newPathComponents, +} from '@edfi/meadowlark-core'; import { securityMiddleware } from '../../src/security/SecurityMiddleware'; import * as OwnershipSecurity from '../../src/repository/OwnershipSecurity'; diff --git a/Meadowlark-js/backends/meadowlark-opensearch-backend/test/integration/QueryOpensearch.test.ts b/Meadowlark-js/backends/meadowlark-opensearch-backend/test/integration/QueryOpensearch.test.ts index 9ac46338..f2385386 100644 --- a/Meadowlark-js/backends/meadowlark-opensearch-backend/test/integration/QueryOpensearch.test.ts +++ b/Meadowlark-js/backends/meadowlark-opensearch-backend/test/integration/QueryOpensearch.test.ts @@ -14,9 +14,11 @@ import { AuthorizationStrategy, DeleteRequest, DeleteResult, + DocumentUuid, + MeadowlarkId, + TraceId, + generateDocumentUuid, } from '@edfi/meadowlark-core'; -import { DocumentUuid, MeadowlarkId, TraceId } from '@edfi/meadowlark-core/src/model/IdTypes'; -import { generateDocumentUuid } from '@edfi/meadowlark-core/src/model/DocumentIdentity'; import { Client } from '@opensearch-project/opensearch/.'; import { queryDocuments } from '../../src/repository/QueryOpensearch'; import { afterDeleteDocumentById, afterUpsertDocument } from '../../src/repository/UpdateOpensearch'; diff --git a/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/OwnershipSecurity.test.ts b/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/OwnershipSecurity.test.ts index fd67e8f8..5c92c13a 100644 --- a/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/OwnershipSecurity.test.ts +++ b/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/OwnershipSecurity.test.ts @@ -16,9 +16,9 @@ import { DocumentUuid, UpsertRequest, TraceId, + newFrontendRequestMiddleware, + newPathComponents } from '@edfi/meadowlark-core'; -import { newFrontendRequestMiddleware } from '@edfi/meadowlark-core/src/handler/FrontendRequest'; -import { newPathComponents } from '@edfi/meadowlark-core/src/model/PathComponents'; import type { PoolClient } from 'pg'; import { getSharedClient, resetSharedClient } from '../../src/repository/Db'; import { deleteAll } from './TestHelper'; diff --git a/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/SecurityMiddleware.test.ts b/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/SecurityMiddleware.test.ts index bcead7a9..2fa59d53 100644 --- a/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/SecurityMiddleware.test.ts +++ b/Meadowlark-js/backends/meadowlark-postgresql-backend/test/integration/SecurityMiddleware.test.ts @@ -17,9 +17,9 @@ import { DocumentUuid, UpsertRequest, TraceId, + newFrontendRequestMiddleware, + newPathComponents, } from '@edfi/meadowlark-core'; -import { newFrontendRequestMiddleware } from '@edfi/meadowlark-core/src/handler/FrontendRequest'; -import { newPathComponents } from '@edfi/meadowlark-core/src/model/PathComponents'; import type { PoolClient } from 'pg'; import { resetSharedClient, getSharedClient } from '../../src/repository/Db'; import { securityMiddleware } from '../../src/security/SecurityMiddleware'; diff --git a/Meadowlark-js/package-lock.json b/Meadowlark-js/package-lock.json index 2e51c83a..436a957b 100644 --- a/Meadowlark-js/package-lock.json +++ b/Meadowlark-js/package-lock.json @@ -1551,6 +1551,7 @@ }, "node_modules/@colors/colors": { "version": "1.5.0", + "dev": true, "license": "MIT", "engines": { "node": ">=0.1.90" @@ -1578,7 +1579,9 @@ }, "node_modules/@dabh/diagnostics": { "version": "2.0.3", - "license": "MIT", + "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz", + "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==", + "dev": true, "dependencies": { "colorspace": "1.1.x", "enabled": "2.0.x", @@ -1589,16 +1592,9 @@ "version": "4.6.1", "resolved": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/npm/registry/@edfi/antlr4/-/antlr4-4.6.1.tgz", "integrity": "sha1-vLgI0jH1J94RP0tM6Aoxv1e/h1c=", + "dev": true, "license": "BSD" }, - "node_modules/@edfi/ed-fi-model-3.1": { - "version": "3.0.1", - "license": "private" - }, - "node_modules/@edfi/ed-fi-model-3.3b": { - "version": "3.0.1", - "license": "private" - }, "node_modules/@edfi/meadowlark-authz-server": { "resolved": "packages/meadowlark-authz-server", "link": true @@ -1636,89 +1632,127 @@ "link": true }, "node_modules/@edfi/metaed-core": { - "version": "4.2.2-dev.3", - "resolved": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/npm/registry/@edfi/metaed-core/-/metaed-core-4.2.2-dev.3.tgz", - "integrity": "sha1-ZHX3ukzWwYgiwPH/M4rRsJYnZ74=", + "version": "4.2.2-dev.8", + "resolved": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/npm/registry/@edfi/metaed-core/-/metaed-core-4.2.2-dev.8.tgz", + "integrity": "sha1-B/PxfMlTgsSDDbt+U0eOFhm553E=", + "dev": true, "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "@edfi/antlr4": "4.6.1", - "ajv": "^6.12.6", + "ajv": "^8.12.0", "chalk": "^4.1.2", - "cosmiconfig": "^5.2.1", + "cosmiconfig": "^8.3.5", "deep-freeze": "^0.0.1", - "deepmerge": "^2.2.1", - "fs-extra": "^5.0.0", - "joi": "12.0.0", - "klaw-sync": "^3.0.2", - "ramda": "^0.28.0", + "deepmerge": "^4.3.1", + "fs-extra": "^11.1.1", + "joi": "^17.10.1", + "klaw-sync": "^6.0.0", + "ramda": "^0.29.0", "semver": "^7.3.8", "sugar": "^2.0.6", - "topo": "2.0.2", - "winston": "3.8.2" + "topo": "^3.0.3", + "winston": "^3.10.0" } }, - "node_modules/@edfi/metaed-core/node_modules/fs-extra": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-5.0.0.tgz", - "integrity": "sha512-66Pm4RYbjzdyeuqudYqhFiNBbCIuI9kgRqLPSHIlXHidW8NIQtVdkM1yeZ4lXwuhbTETv3EUGMNHAAw6hiundQ==", + "node_modules/@edfi/metaed-core/node_modules/ajv": { + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", + "integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==", + "dev": true, "dependencies": { - "graceful-fs": "^4.1.2", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/@edfi/metaed-core/node_modules/jsonfile": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", - "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", - "optionalDependencies": { - "graceful-fs": "^4.1.6" + "node_modules/@edfi/metaed-core/node_modules/fs-extra": { + "version": "11.1.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.1.tgz", + "integrity": "sha512-MGIE4HOvQCeUCzmlHs0vXpih4ysz4wg9qiSAu6cd42lVwPbTM1TjV7RusoyQqMmk/95gdQZX72u+YW+c3eEpFQ==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" } }, + "node_modules/@edfi/metaed-core/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true + }, "node_modules/@edfi/metaed-core/node_modules/ramda": { - "version": "0.28.0", - "resolved": "https://registry.npmjs.org/ramda/-/ramda-0.28.0.tgz", - "integrity": "sha512-9QnLuG/kPVgWvMQ4aODhsBUFKOUmnbUnsSXACv+NCQZcHbeb+v8Lodp8OVxtRULN1/xOyYLLaL6npE6dMq5QTA==", + "version": "0.29.0", + "resolved": "https://registry.npmjs.org/ramda/-/ramda-0.29.0.tgz", + "integrity": "sha512-BBea6L67bYLtdbOqfp8f58fPMqEwx0doL+pAi8TZyp2YWz8R9G8z9x75CZI8W+ftqhFHCpEX2cRnUUXK130iKA==", + "dev": true, "funding": { "type": "opencollective", "url": "https://opencollective.com/ramda" } }, - "node_modules/@edfi/metaed-core/node_modules/universalify": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", - "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", - "engines": { - "node": ">= 4.0.0" - } - }, "node_modules/@edfi/metaed-plugin-edfi-api-schema": { - "version": "4.2.2-dev.3", - "resolved": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/npm/registry/@edfi/metaed-plugin-edfi-api-schema/-/metaed-plugin-edfi-api-schema-4.2.2-dev.3.tgz", - "integrity": "sha1-QdzxtyfGWtqvjM5sL1PcdqGJcj8=", + "version": "4.2.2-dev.8", + "resolved": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/npm/registry/@edfi/metaed-plugin-edfi-api-schema/-/metaed-plugin-edfi-api-schema-4.2.2-dev.8.tgz", + "integrity": "sha1-x/VHk652fP7N0vWgGrHln3NrbHY=", + "dev": true, "license": "Apache-2.0", "dependencies": { - "@edfi/metaed-core": "4.2.2-dev.3", - "@edfi/metaed-plugin-edfi-unified": "4.2.2-dev.3", + "@edfi/metaed-core": "4.2.2-dev.8", + "@edfi/metaed-plugin-edfi-unified": "4.2.2-dev.8", + "ajv": "^8.12.0", "deep-freeze": "^0.0.1", - "inflection": "^1.13.4", + "inflection": "^2.0.1", "ts-invariant": "^0.10.3" } }, + "node_modules/@edfi/metaed-plugin-edfi-api-schema/node_modules/ajv": { + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", + "integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@edfi/metaed-plugin-edfi-api-schema/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true + }, "node_modules/@edfi/metaed-plugin-edfi-unified": { - "version": "4.2.2-dev.3", - "resolved": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/npm/registry/@edfi/metaed-plugin-edfi-unified/-/metaed-plugin-edfi-unified-4.2.2-dev.3.tgz", - "integrity": "sha1-aMD1q/mpwQXw/EKb5RdtxT56dbc=", + "version": "4.2.2-dev.8", + "resolved": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/npm/registry/@edfi/metaed-plugin-edfi-unified/-/metaed-plugin-edfi-unified-4.2.2-dev.8.tgz", + "integrity": "sha1-atMQ9JnKa1opt77Tns4biFAu0+g=", + "dev": true, "license": "SEE LICENSE IN LICENSE.md", "dependencies": { - "@edfi/metaed-core": "4.2.2-dev.3", - "ramda": "^0.28.0" + "@edfi/metaed-core": "4.2.2-dev.8", + "ramda": "^0.29.0" } }, "node_modules/@edfi/metaed-plugin-edfi-unified/node_modules/ramda": { - "version": "0.28.0", - "resolved": "https://registry.npmjs.org/ramda/-/ramda-0.28.0.tgz", - "integrity": "sha512-9QnLuG/kPVgWvMQ4aODhsBUFKOUmnbUnsSXACv+NCQZcHbeb+v8Lodp8OVxtRULN1/xOyYLLaL6npE6dMq5QTA==", + "version": "0.29.0", + "resolved": "https://registry.npmjs.org/ramda/-/ramda-0.29.0.tgz", + "integrity": "sha512-BBea6L67bYLtdbOqfp8f58fPMqEwx0doL+pAi8TZyp2YWz8R9G8z9x75CZI8W+ftqhFHCpEX2cRnUUXK130iKA==", + "dev": true, "funding": { "type": "opencollective", "url": "https://opencollective.com/ramda" @@ -1884,6 +1918,21 @@ "integrity": "sha512-k2Ty1JcVojjJFwrg/ThKi2ujJ7XNLYaFGNB/bWT9wGR+oSMJHMa5w+CUq6p/pVrKeNNgA7pCqEcjSnHVoqJQFw==", "dev": true }, + "node_modules/@hapi/hoek": { + "version": "9.3.0", + "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", + "integrity": "sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==", + "dev": true + }, + "node_modules/@hapi/topo": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-5.1.0.tgz", + "integrity": "sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==", + "dev": true, + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, "node_modules/@humanwhocodes/config-array": { "version": "0.11.10", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.10.tgz", @@ -4673,6 +4722,27 @@ "into-stream": "^6.0.0" } }, + "node_modules/@sideway/address": { + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.4.tgz", + "integrity": "sha512-7vwq+rOHVWjyXxVlR76Agnvhy8I9rpzjosTESvmhNeXOXdZZB15Fl+TI9x1SiHZH5Jv2wTGduSxFDIaq0m3DUw==", + "dev": true, + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@sideway/formula": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@sideway/formula/-/formula-3.0.1.tgz", + "integrity": "sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==", + "dev": true + }, + "node_modules/@sideway/pinpoint": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@sideway/pinpoint/-/pinpoint-2.0.0.tgz", + "integrity": "sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==", + "dev": true + }, "node_modules/@sinclair/typebox": { "version": "0.27.8", "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", @@ -5668,6 +5738,12 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/triple-beam": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.3.tgz", + "integrity": "sha512-6tOUG+nVHn0cJbVp25JFayS5UE6+xlbcNF9Lo9mU7U0zk3zeUShZied4YEQZjy1JBF043FSkdXw8YkUJuVtB5g==", + "dev": true + }, "node_modules/@types/uuid": { "version": "9.0.3", "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-9.0.3.tgz", @@ -6563,6 +6639,7 @@ }, "node_modules/async": { "version": "3.2.4", + "dev": true, "license": "MIT" }, "node_modules/async-lock": { @@ -7605,33 +7682,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/caller-callsite": { - "version": "2.0.0", - "license": "MIT", - "dependencies": { - "callsites": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/caller-callsite/node_modules/callsites": { - "version": "2.0.0", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/caller-path": { - "version": "2.0.0", - "license": "MIT", - "dependencies": { - "caller-callsite": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/callsites": { "version": "3.1.0", "dev": true, @@ -8050,7 +8100,9 @@ }, "node_modules/color": { "version": "3.2.1", - "license": "MIT", + "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz", + "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==", + "dev": true, "dependencies": { "color-convert": "^1.9.3", "color-string": "^1.6.0" @@ -8072,7 +8124,9 @@ }, "node_modules/color-string": { "version": "1.9.1", - "license": "MIT", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "dev": true, "dependencies": { "color-name": "^1.0.0", "simple-swizzle": "^0.2.2" @@ -8089,14 +8143,18 @@ }, "node_modules/color/node_modules/color-convert": { "version": "1.9.3", - "license": "MIT", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, "dependencies": { "color-name": "1.1.3" } }, "node_modules/color/node_modules/color-name": { "version": "1.1.3", - "license": "MIT" + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "dev": true }, "node_modules/colorette": { "version": "2.0.20", @@ -8105,7 +8163,9 @@ }, "node_modules/colorspace": { "version": "1.1.4", - "license": "MIT", + "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz", + "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==", + "dev": true, "dependencies": { "color": "^3.1.3", "text-hex": "1.0.x" @@ -8601,52 +8661,47 @@ "license": "MIT" }, "node_modules/cosmiconfig": { - "version": "5.2.1", - "license": "MIT", + "version": "8.3.6", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.3.6.tgz", + "integrity": "sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==", + "dev": true, "dependencies": { - "import-fresh": "^2.0.0", - "is-directory": "^0.3.1", - "js-yaml": "^3.13.1", - "parse-json": "^4.0.0" + "import-fresh": "^3.3.0", + "js-yaml": "^4.1.0", + "parse-json": "^5.2.0", + "path-type": "^4.0.0" }, "engines": { - "node": ">=4" - } - }, - "node_modules/cosmiconfig/node_modules/argparse": { - "version": "1.0.10", - "license": "MIT", - "dependencies": { - "sprintf-js": "~1.0.2" - } - }, - "node_modules/cosmiconfig/node_modules/import-fresh": { - "version": "2.0.0", - "license": "MIT", - "dependencies": { - "caller-path": "^2.0.0", - "resolve-from": "^3.0.0" + "node": ">=14" }, - "engines": { - "node": ">=4" + "funding": { + "url": "https://github.com/sponsors/d-fischer" + }, + "peerDependencies": { + "typescript": ">=4.9.5" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } } }, - "node_modules/cosmiconfig/node_modules/js-yaml": { - "version": "3.14.1", - "license": "MIT", + "node_modules/cosmiconfig/node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dev": true, "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/cosmiconfig/node_modules/resolve-from": { - "version": "3.0.0", - "license": "MIT", "engines": { - "node": ">=4" + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/crc-32": { @@ -9162,7 +9217,9 @@ }, "node_modules/deep-freeze": { "version": "0.0.1", - "license": "public domain" + "resolved": "https://registry.npmjs.org/deep-freeze/-/deep-freeze-0.0.1.tgz", + "integrity": "sha512-Z+z8HiAvsGwmjqlphnHW5oz6yWlOwu6EQfFTjmeTWlDeda3FS2yv3jhq35TX/ewmsnqB+RX2IdsIOyjJCQN5tg==", + "dev": true }, "node_modules/deep-is": { "version": "0.1.4", @@ -9170,8 +9227,9 @@ "license": "MIT" }, "node_modules/deepmerge": { - "version": "2.2.1", - "license": "MIT", + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", "engines": { "node": ">=0.10.0" } @@ -9655,7 +9713,9 @@ }, "node_modules/enabled": { "version": "2.0.0", - "license": "MIT" + "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", + "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", + "dev": true }, "node_modules/encoding": { "version": "0.1.13", @@ -9756,6 +9816,7 @@ }, "node_modules/error-ex": { "version": "1.3.2", + "dev": true, "license": "MIT", "dependencies": { "is-arrayish": "^0.2.1" @@ -10336,6 +10397,7 @@ }, "node_modules/esprima": { "version": "4.0.1", + "dev": true, "license": "BSD-2-Clause", "bin": { "esparse": "bin/esparse.js", @@ -10636,14 +10698,6 @@ "node": ">= 10.0.0" } }, - "node_modules/fast-json-stringify/node_modules/deepmerge": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", - "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/fast-levenshtein": { "version": "2.0.6", "dev": true, @@ -10748,7 +10802,9 @@ }, "node_modules/fecha": { "version": "4.2.3", - "license": "MIT" + "resolved": "https://registry.npmjs.org/fecha/-/fecha-4.2.3.tgz", + "integrity": "sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw==", + "dev": true }, "node_modules/figures": { "version": "5.0.0", @@ -10932,7 +10988,9 @@ }, "node_modules/fn.name": { "version": "1.1.0", - "license": "MIT" + "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz", + "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw==", + "dev": true }, "node_modules/follow-redirects": { "version": "1.15.2", @@ -11877,11 +11935,11 @@ } }, "node_modules/hoek": { - "version": "4.2.1", - "license": "BSD-3-Clause", - "engines": { - "node": ">=4.0.0" - } + "version": "6.1.3", + "resolved": "https://registry.npmjs.org/hoek/-/hoek-6.1.3.tgz", + "integrity": "sha512-YXXAAhmF9zpQbC7LEcREFtXfGq5K1fmd+4PHkBq8NUqmzW3G+Dq10bI/i0KucLRwss3YYFQ0fSfoxBZYiGUqtQ==", + "deprecated": "This module has moved and is now available at @hapi/hoek. Please update your dependencies as this version is no longer maintained an may contain bugs and security issues.", + "dev": true }, "node_modules/hosted-git-info": { "version": "4.1.0", @@ -12188,11 +12246,13 @@ "dev": true }, "node_modules/inflection": { - "version": "1.13.4", - "engines": [ - "node >= 0.4.0" - ], - "license": "MIT" + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/inflection/-/inflection-2.0.1.tgz", + "integrity": "sha512-wzkZHqpb4eGrOKBl34xy3umnYHx8Si5R1U4fwmdxLo5gdH6mEK8gclckTj/qWqy4Je0bsDYe/qazZYuO7xe3XQ==", + "dev": true, + "engines": { + "node": ">=14.0.0" + } }, "node_modules/inflight": { "version": "1.0.6", @@ -12790,6 +12850,7 @@ }, "node_modules/is-arrayish": { "version": "0.2.1", + "dev": true, "license": "MIT" }, "node_modules/is-bigint": { @@ -12884,13 +12945,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-directory": { - "version": "0.3.1", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-docker": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", @@ -13121,6 +13175,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.0.tgz", "integrity": "sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==", + "dev": true, "engines": { "node": ">=8" } @@ -13233,16 +13288,6 @@ "dev": true, "license": "MIT" }, - "node_modules/isemail": { - "version": "3.2.0", - "license": "BSD-3-Clause", - "dependencies": { - "punycode": "2.x.x" - }, - "engines": { - "node": ">=4.0.0" - } - }, "node_modules/isexe": { "version": "2.0.0", "dev": true, @@ -13608,15 +13653,6 @@ } } }, - "node_modules/jest-config/node_modules/deepmerge": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", - "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/jest-config/node_modules/parse-json": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", @@ -14042,15 +14078,16 @@ } }, "node_modules/joi": { - "version": "12.0.0", - "license": "BSD-3-Clause", + "version": "17.10.1", + "resolved": "https://registry.npmjs.org/joi/-/joi-17.10.1.tgz", + "integrity": "sha512-vIiDxQKmRidUVp8KngT8MZSOcmRVm2zV7jbMjNYWuHcJWI0bUck3nRTGQjhpPlQenIQIBC5Vp9AhcnHbWQqafw==", + "dev": true, "dependencies": { - "hoek": "4.x.x", - "isemail": "3.x.x", - "topo": "2.x.x" - }, - "engines": { - "node": ">=4.0.0" + "@hapi/hoek": "^9.0.0", + "@hapi/topo": "^5.0.0", + "@sideway/address": "^4.1.3", + "@sideway/formula": "^3.0.1", + "@sideway/pinpoint": "^2.0.0" } }, "node_modules/joycon": { @@ -14201,6 +14238,7 @@ }, "node_modules/json-parse-better-errors": { "version": "1.0.2", + "dev": true, "license": "MIT" }, "node_modules/json-parse-even-better-errors": { @@ -14390,8 +14428,10 @@ } }, "node_modules/klaw-sync": { - "version": "3.0.2", - "license": "MIT", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-6.0.0.tgz", + "integrity": "sha512-nIeuVSzdCCs6TDPTqI8w1Yre34sSq7AkZ4B3sfOBbI2CgVSB4Du4aLQijFU2+lhAFCwt9+42Hel6lQNIv6AntQ==", + "dev": true, "dependencies": { "graceful-fs": "^4.1.11" } @@ -14407,7 +14447,9 @@ }, "node_modules/kuler": { "version": "2.0.0", - "license": "MIT" + "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz", + "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==", + "dev": true }, "node_modules/labeled-stream-splicer": { "version": "2.0.2", @@ -14904,10 +14946,13 @@ } }, "node_modules/logform": { - "version": "2.4.2", - "license": "MIT", + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/logform/-/logform-2.5.1.tgz", + "integrity": "sha512-9FyqAm9o9NKKfiAKfZoYo9bGXXuwMkxQiQttkT4YjjVtQVIQtK6LmVtlxmCaFswo6N4AfEkHqZTV0taDtPotNg==", + "dev": true, "dependencies": { "@colors/colors": "1.5.0", + "@types/triple-beam": "^1.3.2", "fecha": "^4.2.0", "ms": "^2.1.1", "safe-stable-stringify": "^2.3.1", @@ -17491,7 +17536,9 @@ }, "node_modules/one-time": { "version": "1.0.0", - "license": "MIT", + "resolved": "https://registry.npmjs.org/one-time/-/one-time-1.0.0.tgz", + "integrity": "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==", + "dev": true, "dependencies": { "fn.name": "1.x.x" } @@ -17945,6 +17992,7 @@ }, "node_modules/parse-json": { "version": "4.0.0", + "dev": true, "license": "MIT", "dependencies": { "error-ex": "^1.3.1", @@ -20405,14 +20453,18 @@ }, "node_modules/simple-swizzle": { "version": "0.2.2", - "license": "MIT", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", + "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==", + "dev": true, "dependencies": { "is-arrayish": "^0.3.1" } }, "node_modules/simple-swizzle/node_modules/is-arrayish": { "version": "0.3.2", - "license": "MIT" + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", + "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==", + "dev": true }, "node_modules/single-line-log": { "version": "1.1.2", @@ -20662,6 +20714,7 @@ }, "node_modules/sprintf-js": { "version": "1.0.3", + "dev": true, "license": "BSD-3-Clause" }, "node_modules/ssh-remote-port-forward": { @@ -20733,7 +20786,9 @@ }, "node_modules/stack-trace": { "version": "0.0.10", - "license": "MIT", + "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.10.tgz", + "integrity": "sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg==", + "dev": true, "engines": { "node": "*" } @@ -21264,7 +21319,9 @@ }, "node_modules/sugar": { "version": "2.0.6", - "license": "MIT", + "resolved": "https://registry.npmjs.org/sugar/-/sugar-2.0.6.tgz", + "integrity": "sha512-s0P2/pjJtAD9VA44+2Gqm3NdC4v+08melA6YubOxzshu628krTbn95/M2GWMrI9rYspZMpYBIrChR46fjQ7xsQ==", + "dev": true, "dependencies": { "sugar-core": "^2.0.0" }, @@ -21274,7 +21331,9 @@ }, "node_modules/sugar-core": { "version": "2.0.6", - "license": "MIT", + "resolved": "https://registry.npmjs.org/sugar-core/-/sugar-core-2.0.6.tgz", + "integrity": "sha512-YmLFysR3Si6RImqL1+aB6JH81EXxvXn5iXhPf2PsjfoUYEwCxFDYCQY+zC3WqviuGWzxFaSkkJvkUE05Y03L5Q==", + "dev": true, "engines": { "node": ">= 0.8.23" } @@ -21529,7 +21588,9 @@ }, "node_modules/text-hex": { "version": "1.0.0", - "license": "MIT" + "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz", + "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", + "dev": true }, "node_modules/text-table": { "version": "0.2.0", @@ -21670,13 +21731,13 @@ "dev": true }, "node_modules/topo": { - "version": "2.0.2", - "license": "BSD-3-Clause", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/topo/-/topo-3.0.3.tgz", + "integrity": "sha512-IgpPtvD4kjrJ7CRA3ov2FhWQADwv+Tdqbsf1ZnPUSAtCJ9e1Z44MmoSGDXGk4IppoZA7jd/QRkNddlLJWlUZsQ==", + "deprecated": "This module has moved and is now available at @hapi/topo. Please update your dependencies as this version is no longer maintained an may contain bugs and security issues.", + "dev": true, "dependencies": { - "hoek": "4.x.x" - }, - "engines": { - "node": ">=4.0.0" + "hoek": "6.x.x" } }, "node_modules/tough-cookie": { @@ -21791,8 +21852,13 @@ } }, "node_modules/triple-beam": { - "version": "1.3.0", - "license": "MIT" + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.4.1.tgz", + "integrity": "sha512-aZbgViZrg1QNcG+LULa7nhZpJTZSLm/mXnHXnbAbjmN5aSa0y7V+wvv6+4WaBtpISJzThKy+PIPxc1Nq1EJ9mg==", + "dev": true, + "engines": { + "node": ">= 14.0.0" + } }, "node_modules/ts-invariant": { "version": "0.10.3", @@ -22699,8 +22765,10 @@ } }, "node_modules/winston": { - "version": "3.8.2", - "license": "MIT", + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/winston/-/winston-3.10.0.tgz", + "integrity": "sha512-nT6SIDaE9B7ZRO0u3UvdrimG0HkB7dSTAgInQnNR2SOPJ4bvq5q79+pXLftKmP52lJGW15+H5MCK0nM9D3KB/g==", + "dev": true, "dependencies": { "@colors/colors": "1.5.0", "@dabh/diagnostics": "^2.0.2", @@ -22720,7 +22788,9 @@ }, "node_modules/winston-transport": { "version": "4.5.0", - "license": "MIT", + "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.5.0.tgz", + "integrity": "sha512-YpZzcUzBedhlTAfJg6vJDlyEai/IFMIVcaEZZyl3UXIl4gmqRpU7AE89AHLkbzLUsv0NVmw7ts+iztqKxxPW1Q==", + "dev": true, "dependencies": { "logform": "^2.3.2", "readable-stream": "^3.6.0", @@ -23120,12 +23190,7 @@ "license": "Apache-2.0", "dependencies": { "@apideck/better-ajv-errors": "^0.3.6", - "@edfi/ed-fi-model-3.1": "3.0.1", - "@edfi/ed-fi-model-3.3b": "3.0.1", "@edfi/meadowlark-utilities": "^v0.3.6-pre-36", - "@edfi/metaed-core": "^4.2.2-dev.3", - "@edfi/metaed-plugin-edfi-api-schema": "^4.2.2-dev.3", - "@edfi/metaed-plugin-edfi-unified": "^4.2.2-dev.3", "@isaacs/ttlcache": "^1.4.1", "ajv": "^8.12.0", "ajv-formats": "^2.1.1", @@ -23146,6 +23211,9 @@ "xml2js": "^0.6.2" }, "devDependencies": { + "@edfi/metaed-core": "^4.2.2-dev.5", + "@edfi/metaed-plugin-edfi-api-schema": "^4.2.2-dev.5", + "@edfi/metaed-plugin-edfi-unified": "^4.2.2-dev.5", "@types/fs-extra": "^11.0.1", "@types/inflection": "^1.13.0", "@types/js-yaml": "^4.0.5", diff --git a/Meadowlark-js/packages/meadowlark-core/package.json b/Meadowlark-js/packages/meadowlark-core/package.json index b5eb6152..728ff054 100644 --- a/Meadowlark-js/packages/meadowlark-core/package.json +++ b/Meadowlark-js/packages/meadowlark-core/package.json @@ -14,12 +14,7 @@ ], "dependencies": { "@apideck/better-ajv-errors": "^0.3.6", - "@edfi/ed-fi-model-3.1": "3.0.1", - "@edfi/ed-fi-model-3.3b": "3.0.1", "@edfi/meadowlark-utilities": "^v0.3.6-pre-36", - "@edfi/metaed-core": "^4.2.2-dev.3", - "@edfi/metaed-plugin-edfi-api-schema": "^4.2.2-dev.3", - "@edfi/metaed-plugin-edfi-unified": "^4.2.2-dev.3", "@isaacs/ttlcache": "^1.4.1", "ajv": "^8.12.0", "ajv-formats": "^2.1.1", @@ -40,6 +35,9 @@ "xml2js": "^0.6.2" }, "devDependencies": { + "@edfi/metaed-core": "^4.2.2-dev.5", + "@edfi/metaed-plugin-edfi-api-schema": "^4.2.2-dev.5", + "@edfi/metaed-plugin-edfi-unified": "^4.2.2-dev.5", "@types/fs-extra": "^11.0.1", "@types/inflection": "^1.13.0", "@types/js-yaml": "^4.0.5", diff --git a/Meadowlark-js/packages/meadowlark-core/src/Constants.ts b/Meadowlark-js/packages/meadowlark-core/src/Constants.ts index 553f556e..236ba461 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/Constants.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/Constants.ts @@ -4,14 +4,6 @@ // See the LICENSE and NOTICES files in the project root for more information. export abstract class Constants { - static readonly uriVersion31: string = 'v3.1'; - - static readonly projectVersion31: string = '3.1.0'; - - static readonly uriVersion33b: string = 'v3.3b'; - - static readonly projectVersion33b: string = '3.3.1-b'; - static readonly swaggerResourceUrl: string = 'https://edfidata.s3.us-west-2.amazonaws.com/Meadowlark/3.3.0-b-resource.json'; diff --git a/Meadowlark-js/packages/meadowlark-core/src/Logger.ts b/Meadowlark-js/packages/meadowlark-core/src/Logger.ts index a45e2945..da027112 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/Logger.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/Logger.ts @@ -6,32 +6,23 @@ import { isDebugEnabled, isInfoEnabled, Logger, writeErrorToLog as logError } from '@edfi/meadowlark-utilities'; import { FrontendRequest } from './handler/FrontendRequest'; +import { TraceId } from './model/IdTypes'; export function writeDebugStatusToLog( moduleName: string, - request: FrontendRequest, + traceId: TraceId, method: string, statusCode?: number, message?: string, extra?: any, ): void { if (isDebugEnabled()) { - Logger.debug(`${moduleName}.${method} ${statusCode ?? ''} ${message ?? ''}`.trimEnd(), request.traceId, extra); + Logger.debug(`${moduleName}.${method} ${statusCode ?? ''} ${message ?? ''}`.trimEnd(), traceId, extra); } } -export function writeDebugObject( - moduleName: string, - request: FrontendRequest, - method: string, - statusCode?: number, - messageBody?: object, -): void { - Logger.debug(`${moduleName}.${method} ${statusCode}`, request.traceId, messageBody); -} - -export function writeDebugMessage(moduleName: string, request: FrontendRequest, method: string, message: string): void { - Logger.debug(`${moduleName}.${method}`, request.traceId, message); +export function writeDebugMessage(moduleName: string, method: string, traceId: TraceId, message: string): void { + Logger.debug(`${moduleName}.${method}`, traceId, message); } export function writeRequestToLog(moduleName: string, request: FrontendRequest, method: string, extra?: any): void { @@ -40,6 +31,6 @@ export function writeRequestToLog(moduleName: string, request: FrontendRequest, } } -export function writeErrorToLog(moduleName: string, traceId: string, functionName: string, error: any): void { +export function writeErrorToLog(moduleName: string, traceId: TraceId, functionName: string, error: any): void { logError(moduleName, traceId, functionName, undefined, error); } diff --git a/Meadowlark-js/packages/meadowlark-core/src/api-schema/ProjectSchemaFinder.ts b/Meadowlark-js/packages/meadowlark-core/src/api-schema/ProjectSchemaFinder.ts new file mode 100644 index 00000000..2633ea00 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/api-schema/ProjectSchemaFinder.ts @@ -0,0 +1,112 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import path from 'path'; +import fs from 'fs-extra'; +import { NoProjectSchema, ProjectSchema } from '../model/api-schema/ProjectSchema'; +import { writeDebugMessage, writeErrorToLog } from '../Logger'; +import type { ApiSchema } from '../model/api-schema/ApiSchema'; +import { TraceId } from '../model/IdTypes'; +import { EndpointName } from '../model/api-schema/EndpointName'; +import { ProjectNamespace } from '../model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../model/ProjectShortVersion'; + +const moduleName = 'LoadProjectSchema'; + +const dataStandard33bPath: string = path.resolve(__dirname, '../ds-schemas/DataStandard-3.3.1-b.json'); +const dataStandard50pre1Path: string = path.resolve(__dirname, '../ds-schemas/DataStandard-5.0.0-pre.1.json'); + +const projectNamespaceEdfi: ProjectNamespace = 'ed-fi' as ProjectNamespace; + +const projectShortVersion33b: ProjectShortVersion = 'v3.3b' as ProjectShortVersion; +const projectShortVersion50pre1: ProjectShortVersion = 'v5.0-pre.1' as ProjectShortVersion; + +/** + * This is a simple cache implementation that works in Lambdas, see: https://rewind.io/blog/simple-caching-in-aws-lambda-functions/ + */ +const projectSchemaCache = {}; + +function cacheKeyFrom(projectNamespace: ProjectNamespace, projectShortVersion: ProjectShortVersion): string { + return `${projectNamespace}|${projectShortVersion}`; +} + +function setProjectSchemaInCache( + projectNamespace: ProjectNamespace, + projectShortVersion: ProjectShortVersion, + apiSchema: ProjectSchema, +) { + projectSchemaCache[cacheKeyFrom(projectNamespace, projectShortVersion)] = apiSchema; +} + +function getProjectSchemaFromCache( + projectNamespace: ProjectNamespace, + projectShortVersion: ProjectShortVersion, +): ProjectSchema | undefined { + return projectSchemaCache[cacheKeyFrom(projectNamespace, projectShortVersion)]; +} + +/** + * Loads ProjectSchema from an ApiSchema JSON file + */ +async function loadProjectSchemaFromFile( + projectNamespace: ProjectNamespace, + projectShortVersion: ProjectShortVersion, + filePath: string, + traceId: TraceId, +): Promise { + const projectSchema: ProjectSchema = ((await fs.readJson(filePath)) as ApiSchema).projectSchemas[projectNamespace]; + setProjectSchemaInCache(projectNamespace, projectShortVersion, projectSchema); + writeDebugMessage(moduleName, 'loadProjectSchema', traceId, `Loading ApiSchema from ${filePath}`); + return projectSchema; +} + +/** + * Entry point for loading ProjectSchemas from a file + */ +export async function findProjectSchema( + projectNamespace: ProjectNamespace, + projectShortVersion: ProjectShortVersion, + traceId: TraceId, +): Promise { + const cachedProjectSchema: ProjectSchema | undefined = getProjectSchemaFromCache(projectNamespace, projectShortVersion); + if (cachedProjectSchema != null) return cachedProjectSchema; + + // Only supporting data standards right now + if (projectNamespace !== projectNamespaceEdfi) { + writeDebugMessage(moduleName, 'getProjectSchema', traceId, `Namespace ${projectNamespace} on URL is unknown.`); + return NoProjectSchema; + } + + try { + if (projectShortVersion === projectShortVersion33b) { + return await loadProjectSchemaFromFile(projectNamespaceEdfi, projectShortVersion33b, dataStandard33bPath, traceId); + } + if (projectShortVersion === projectShortVersion50pre1) { + return await loadProjectSchemaFromFile( + projectNamespaceEdfi, + projectShortVersion50pre1, + dataStandard50pre1Path, + traceId, + ); + } + + writeDebugMessage(moduleName, 'getProjectSchema', traceId, `Version ${projectShortVersion} on URL is unknown.`); + } catch (e) { + writeErrorToLog(moduleName, traceId, 'getProjectSchema', e); + } + return NoProjectSchema; +} + +/** + * Returns a list of the valid endpoint names for a ProjectSchema. + */ +export function validEndpointNamesFor( + projectNamespace: ProjectNamespace, + projectShortVersion: ProjectShortVersion, +): EndpointName[] { + const projectSchema: ProjectSchema | undefined = getProjectSchemaFromCache(projectNamespace, projectShortVersion); + if (projectSchema == null) return []; + return Object.keys(projectSchema.resourceSchemas) as EndpointName[]; +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/api-schema/ResourceSchemaFinder.ts b/Meadowlark-js/packages/meadowlark-core/src/api-schema/ResourceSchemaFinder.ts new file mode 100644 index 00000000..eda5fd0a --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/api-schema/ResourceSchemaFinder.ts @@ -0,0 +1,25 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import type { PathComponents } from '../model/PathComponents'; +import type { ResourceSchema } from '../model/api-schema/ResourceSchema'; +import { findProjectSchema } from './ProjectSchemaFinder'; +import type { TraceId } from '../model/IdTypes'; +import { ProjectSchema } from '../model/api-schema/ProjectSchema'; + +/** + * Finds the ResourceSchema that represents the given REST resource path. + */ +export async function findResourceSchema( + pathComponents: PathComponents, + traceId: TraceId, +): Promise { + const projectSchema: ProjectSchema = await findProjectSchema( + pathComponents.projectNamespace, + pathComponents.projectShortVersion, + traceId, + ); + return projectSchema.resourceSchemas[pathComponents.endpointName]; +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-3.3.1-b.json b/Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-3.3.1-b.json new file mode 100644 index 00000000..6b766956 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-3.3.1-b.json @@ -0,0 +1,73015 @@ +{ + "projectSchemas": { + "ed-fi": { + "projectName": "Ed-Fi", + "projectVersion": "3.3.1-b", + "isExtensionProject": false, + "description": "The Ed-Fi Data Model 3.3b", + "resourceSchemas": { + "academicWeeks": { + "resourceName": "AcademicWeek", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AcademicWeek", + "description": "This entity represents the academic weeks for a school year, optionally captured to support analyses.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the academic week." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the academic week." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total instructional days during the academic week.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "weekIdentifier", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AcademicWeek", + "description": "This entity represents the academic weeks for a school year, optionally captured to support analyses.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the academic week." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the academic week." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total instructional days during the academic week.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "weekIdentifier", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AcademicWeek", + "description": "This entity represents the academic weeks for a school year, optionally captured to support analyses.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the academic week." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the academic week." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total instructional days during the academic week.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "WeekIdentifier" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "WeekIdentifier": [ + "$.weekIdentifier" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "TotalInstructionalDays": [ + "$.totalInstructionalDays" + ] + } + }, + "accounts": { + "resourceName": "Account", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Account", + "description": "This financial entity represents a funding source combined with its purpose and type of transaction. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "accountCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accountCodeReference": { + "type": "object", + "properties": { + "accountClassificationDescriptor": { + "type": "string", + "description": "The type of account code associated with the account." + }, + "accountCodeNumber": { + "type": "string", + "description": "An account code defined for the education accounting system by the education organization.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountClassificationDescriptor", + "accountCodeNumber", + "educationOrganizationId", + "fiscalYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "accountCodeReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "accountCodes", + "fiscalYear", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Account", + "description": "This financial entity represents a funding source combined with its purpose and type of transaction. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "accountCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accountCodeReference": { + "type": "object", + "properties": { + "accountClassificationDescriptor": { + "type": "string", + "description": "The type of account code associated with the account." + }, + "accountCodeNumber": { + "type": "string", + "description": "An account code defined for the education accounting system by the education organization.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountClassificationDescriptor", + "accountCodeNumber", + "educationOrganizationId", + "fiscalYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "accountCodeReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "accountIdentifier", + "accountCodes", + "fiscalYear", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Account", + "description": "This financial entity represents a funding source combined with its purpose and type of transaction. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "accountCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accountCodeReference": { + "type": "object", + "properties": { + "accountClassificationDescriptor": { + "type": "string", + "description": "The type of account code associated with the account." + }, + "accountCodeNumber": { + "type": "string", + "description": "An account code defined for the education accounting system by the education organization.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountClassificationDescriptor", + "accountCodeNumber", + "educationOrganizationId", + "fiscalYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "accountCodeReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.accountCodes[*].accountCodeReference.educationOrganizationId", + "targetJsonPath": "$.educationOrganizationReference.educationOrganizationId" + } + ], + "identityFullnames": [ + "AccountIdentifier", + "FiscalYear", + "EducationOrganization" + ], + "documentPathsMapping": { + "AccountIdentifier": [ + "$.accountIdentifier" + ], + "AccountCode": [ + "$.accountCodes[*].accountCodeReference.accountClassificationDescriptor", + "$.accountCodes[*].accountCodeReference.accountCodeNumber", + "$.accountCodes[*].accountCodeReference.educationOrganizationId", + "$.accountCodes[*].accountCodeReference.fiscalYear" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "AccountName": [ + "$.accountName" + ] + } + }, + "accountabilityRatings": { + "resourceName": "AccountabilityRating", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountabilityRating", + "description": "An accountability rating for a school or district.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "ratingTitle": { + "type": "string", + "description": "The title of the rating (e.g., School Rating, Safety Score).", + "minLength": 1, + "maxLength": 60 + }, + "rating": { + "type": "string", + "description": "An accountability rating level, designation, or assessment.", + "minLength": 1, + "maxLength": 35 + }, + "ratingDate": { + "type": "string", + "format": "date", + "description": "The date the rating was awarded." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "ratingOrganization": { + "type": "string", + "description": "The organization that assessed the rating.", + "minLength": 1, + "maxLength": 35 + }, + "ratingProgram": { + "type": "string", + "description": "The program associated with the AccountabilityRating (e.g., NCLB, AEIS).", + "minLength": 1, + "maxLength": 30 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationReference", + "ratingTitle", + "rating", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountabilityRating", + "description": "An accountability rating for a school or district.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "ratingTitle": { + "type": "string", + "description": "The title of the rating (e.g., School Rating, Safety Score).", + "minLength": 1, + "maxLength": 60 + }, + "rating": { + "type": "string", + "description": "An accountability rating level, designation, or assessment.", + "minLength": 1, + "maxLength": 35 + }, + "ratingDate": { + "type": "string", + "format": "date", + "description": "The date the rating was awarded." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "ratingOrganization": { + "type": "string", + "description": "The organization that assessed the rating.", + "minLength": 1, + "maxLength": 35 + }, + "ratingProgram": { + "type": "string", + "description": "The program associated with the AccountabilityRating (e.g., NCLB, AEIS).", + "minLength": 1, + "maxLength": 30 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationOrganizationReference", + "ratingTitle", + "rating", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountabilityRating", + "description": "An accountability rating for a school or district.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "ratingTitle": { + "type": "string", + "description": "The title of the rating (e.g., School Rating, Safety Score).", + "minLength": 1, + "maxLength": 60 + }, + "rating": { + "type": "string", + "description": "An accountability rating level, designation, or assessment.", + "minLength": 1, + "maxLength": 35 + }, + "ratingDate": { + "type": "string", + "format": "date", + "description": "The date the rating was awarded." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "ratingOrganization": { + "type": "string", + "description": "The organization that assessed the rating.", + "minLength": 1, + "maxLength": 35 + }, + "ratingProgram": { + "type": "string", + "description": "The program associated with the AccountabilityRating (e.g., NCLB, AEIS).", + "minLength": 1, + "maxLength": 30 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "RatingTitle", + "SchoolYear" + ], + "documentPathsMapping": { + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "RatingTitle": [ + "$.ratingTitle" + ], + "Rating": [ + "$.rating" + ], + "RatingDate": [ + "$.ratingDate" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "RatingOrganization": [ + "$.ratingOrganization" + ], + "RatingProgram": [ + "$.ratingProgram" + ] + } + }, + "accountCodes": { + "resourceName": "AccountCode", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountCode", + "description": "The set of account codes defined by an education organization for a fiscal year.", + "type": "object", + "properties": { + "accountCodeNumber": { + "type": "string", + "description": "An account code defined for the education accounting system by the education organization.", + "minLength": 1, + "maxLength": 50 + }, + "accountClassificationDescriptor": { + "type": "string", + "description": "The type of account code associated with the account." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + }, + "accountCodeDescription": { + "type": "string", + "description": "A description of the account code.", + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "accountCodeNumber", + "accountClassificationDescriptor", + "educationOrganizationReference", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountCode", + "description": "The set of account codes defined by an education organization for a fiscal year.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "accountCodeNumber": { + "type": "string", + "description": "An account code defined for the education accounting system by the education organization.", + "minLength": 1, + "maxLength": 50 + }, + "accountClassificationDescriptor": { + "type": "string", + "description": "The type of account code associated with the account." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + }, + "accountCodeDescription": { + "type": "string", + "description": "A description of the account code.", + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "accountCodeNumber", + "accountClassificationDescriptor", + "educationOrganizationReference", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountCode", + "description": "The set of account codes defined by an education organization for a fiscal year.", + "type": "object", + "properties": { + "accountCodeNumber": { + "type": "string", + "description": "An account code defined for the education accounting system by the education organization.", + "minLength": 1, + "maxLength": 50 + }, + "accountClassificationDescriptor": { + "type": "string", + "description": "The type of account code associated with the account." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + }, + "accountCodeDescription": { + "type": "string", + "description": "A description of the account code.", + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "AccountCodeNumber", + "AccountClassification", + "EducationOrganization", + "FiscalYear" + ], + "documentPathsMapping": { + "AccountCodeNumber": [ + "$.accountCodeNumber" + ], + "AccountClassification": [ + "$.accountClassificationDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "AccountCodeDescription": [ + "$.accountCodeDescription" + ] + } + }, + "actuals": { + "resourceName": "Actual", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Actual", + "description": "This financial entity represents the sum of the financial transactions to date relating to a specific account.", + "type": "object", + "properties": { + "amountToDate": { + "type": "number", + "description": "Current balance for the account." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported actual element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "amountToDate", + "asOfDate", + "accountReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Actual", + "description": "This financial entity represents the sum of the financial transactions to date relating to a specific account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "amountToDate": { + "type": "number", + "description": "Current balance for the account." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported actual element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "amountToDate", + "asOfDate", + "accountReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Actual", + "description": "This financial entity represents the sum of the financial transactions to date relating to a specific account.", + "type": "object", + "properties": { + "amountToDate": { + "type": "number", + "description": "Current balance for the account." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported actual element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "AsOfDate", + "Account" + ], + "documentPathsMapping": { + "AmountToDate": [ + "$.amountToDate" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Account": [ + "$.accountReference.accountIdentifier", + "$.accountReference.educationOrganizationId", + "$.accountReference.fiscalYear" + ] + } + }, + "assessments": { + "resourceName": "Assessment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Assessment", + "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.", + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentTitle": { + "type": "string", + "description": "The title or name of the Assessment.", + "minLength": 1, + "maxLength": 100 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the assessment identification code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentCategoryDescriptor": { + "type": "string", + "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 ..." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "assessedGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "assessmentForm": { + "type": "string", + "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentVersion": { + "type": "integer", + "description": "The version identifier for the assessment." + }, + "revisionDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for Assessment.", + "minLength": 1, + "maxLength": 35 + }, + "period": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "assessmentFamily": { + "type": "string", + "description": "The AssessmentFamily this Assessment is a member of.", + "minLength": 1, + "maxLength": 60 + }, + "sections": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "sectionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "adaptiveAssessment": { + "type": "boolean", + "description": "Indicates that the assessment is adaptive." + }, + "platformTypes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "platformTypeDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "platformTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "assessmentTitle", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Assessment", + "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.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentTitle": { + "type": "string", + "description": "The title or name of the Assessment.", + "minLength": 1, + "maxLength": 100 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the assessment identification code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentCategoryDescriptor": { + "type": "string", + "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 ..." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "assessedGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "assessmentForm": { + "type": "string", + "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentVersion": { + "type": "integer", + "description": "The version identifier for the assessment." + }, + "revisionDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for Assessment.", + "minLength": 1, + "maxLength": 35 + }, + "period": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "assessmentFamily": { + "type": "string", + "description": "The AssessmentFamily this Assessment is a member of.", + "minLength": 1, + "maxLength": 60 + }, + "sections": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "sectionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "adaptiveAssessment": { + "type": "boolean", + "description": "Indicates that the assessment is adaptive." + }, + "platformTypes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "platformTypeDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "platformTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "assessmentIdentifier", + "assessmentTitle", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Assessment", + "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.", + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentTitle": { + "type": "string", + "description": "The title or name of the Assessment.", + "minLength": 1, + "maxLength": 100 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the assessment identification code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentCategoryDescriptor": { + "type": "string", + "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 ..." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "assessedGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "assessmentForm": { + "type": "string", + "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentVersion": { + "type": "integer", + "description": "The version identifier for the assessment." + }, + "revisionDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for Assessment.", + "minLength": 1, + "maxLength": 35 + }, + "period": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "assessmentFamily": { + "type": "string", + "description": "The AssessmentFamily this Assessment is a member of.", + "minLength": 1, + "maxLength": 60 + }, + "sections": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "sectionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "adaptiveAssessment": { + "type": "boolean", + "description": "Indicates that the assessment is adaptive." + }, + "platformTypes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "platformTypeDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "platformTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "AssessmentIdentifier", + "Namespace" + ], + "documentPathsMapping": { + "AssessmentIdentifier": [ + "$.assessmentIdentifier" + ], + "AssessmentTitle": [ + "$.assessmentTitle" + ], + "AssessmentCategory": [ + "$.assessmentCategoryDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "AssessedGradeLevel": [ + "$.assessedGradeLevels[*].gradeLevelDescriptor" + ], + "AssessmentForm": [ + "$.assessmentForm" + ], + "Language": [ + "$.languages[*].languageDescriptor" + ], + "AssessmentVersion": [ + "$.assessmentVersion" + ], + "RevisionDate": [ + "$.revisionDate" + ], + "MaxRawScore": [ + "$.maxRawScore" + ], + "Nomenclature": [ + "$.nomenclature" + ], + "AssessmentFamily": [ + "$.assessmentFamily" + ], + "Namespace": [ + "$.namespace" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "AdaptiveAssessment": [ + "$.adaptiveAssessment" + ], + "PlatformType": [ + "$.platformTypes[*].platformTypeDescriptor" + ] + } + }, + "assessmentItems": { + "resourceName": "AssessmentItem", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentItem", + "description": "This entity represents one of many single measures that make up an assessment.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentItemCategoryDescriptor": { + "type": "string", + "description": "Category or type of the AssessmentItem. For example: Multiple choice Analytic Prose ..." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "itemText": { + "type": "string", + "description": "The text of the item.", + "minLength": 1, + "maxLength": 1024 + }, + "possibleResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "responseValue": { + "type": "string", + "description": "The response value, often an option number or code value (e.g., 1, 2, A, B, true, false).", + "minLength": 1, + "maxLength": 60 + }, + "responseDescription": { + "type": "string", + "description": "Additional text provided to define the response value.", + "minLength": 1, + "maxLength": 1024 + }, + "correctResponse": { + "type": "boolean", + "description": "Indicates the response is correct." + } + }, + "additionalProperties": false, + "required": [ + "responseValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "correctResponse": { + "type": "string", + "description": "The correct response for the AssessmentItem.", + "minLength": 1, + "maxLength": 20 + }, + "expectedTimeAssessed": { + "type": "number", + "description": "The duration of time allotted for the AssessmentItem." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for AssessmentItem.", + "minLength": 1, + "maxLength": 35 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "assessmentItemURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentItem", + "description": "This entity represents one of many single measures that make up an assessment.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentItemCategoryDescriptor": { + "type": "string", + "description": "Category or type of the AssessmentItem. For example: Multiple choice Analytic Prose ..." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "itemText": { + "type": "string", + "description": "The text of the item.", + "minLength": 1, + "maxLength": 1024 + }, + "possibleResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "responseValue": { + "type": "string", + "description": "The response value, often an option number or code value (e.g., 1, 2, A, B, true, false).", + "minLength": 1, + "maxLength": 60 + }, + "responseDescription": { + "type": "string", + "description": "Additional text provided to define the response value.", + "minLength": 1, + "maxLength": 1024 + }, + "correctResponse": { + "type": "boolean", + "description": "Indicates the response is correct." + } + }, + "additionalProperties": false, + "required": [ + "responseValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "correctResponse": { + "type": "string", + "description": "The correct response for the AssessmentItem.", + "minLength": 1, + "maxLength": 20 + }, + "expectedTimeAssessed": { + "type": "number", + "description": "The duration of time allotted for the AssessmentItem." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for AssessmentItem.", + "minLength": 1, + "maxLength": 35 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "assessmentItemURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentItem", + "description": "This entity represents one of many single measures that make up an assessment.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentItemCategoryDescriptor": { + "type": "string", + "description": "Category or type of the AssessmentItem. For example: Multiple choice Analytic Prose ..." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "itemText": { + "type": "string", + "description": "The text of the item.", + "minLength": 1, + "maxLength": 1024 + }, + "possibleResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "responseValue": { + "type": "string", + "description": "The response value, often an option number or code value (e.g., 1, 2, A, B, true, false).", + "minLength": 1, + "maxLength": 60 + }, + "responseDescription": { + "type": "string", + "description": "Additional text provided to define the response value.", + "minLength": 1, + "maxLength": 1024 + }, + "correctResponse": { + "type": "boolean", + "description": "Indicates the response is correct." + } + }, + "additionalProperties": false, + "required": [ + "responseValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "correctResponse": { + "type": "string", + "description": "The correct response for the AssessmentItem.", + "minLength": 1, + "maxLength": 20 + }, + "expectedTimeAssessed": { + "type": "number", + "description": "The duration of time allotted for the AssessmentItem." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for AssessmentItem.", + "minLength": 1, + "maxLength": 35 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "assessmentItemURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "IdentificationCode", + "Assessment" + ], + "documentPathsMapping": { + "IdentificationCode": [ + "$.identificationCode" + ], + "AssessmentItemCategory": [ + "$.assessmentItemCategoryDescriptor" + ], + "MaxRawScore": [ + "$.maxRawScore" + ], + "ItemText": [ + "$.itemText" + ], + "CorrectResponse": [ + "$.correctResponse" + ], + "ExpectedTimeAssessed": [ + "$.expectedTimeAssessed" + ], + "Nomenclature": [ + "$.nomenclature" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "AssessmentItemURI": [ + "$.assessmentItemURI" + ] + } + }, + "assessmentScoreRangeLearningStandards": { + "resourceName": "AssessmentScoreRangeLearningStandard", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentScoreRangeLearningStandard", + "description": "Score ranges of an assessment associated with one or more learning standards.", + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "scoreRangeId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s)." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference", + "learningStandards", + "scoreRangeId", + "minimumScore", + "maximumScore" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentScoreRangeLearningStandard", + "description": "Score ranges of an assessment associated with one or more learning standards.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "scoreRangeId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s)." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "assessmentReference", + "learningStandards", + "scoreRangeId", + "minimumScore", + "maximumScore" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentScoreRangeLearningStandard", + "description": "Score ranges of an assessment associated with one or more learning standards.", + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "scoreRangeId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s)." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.objectiveAssessmentReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.objectiveAssessmentReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + } + ], + "identityFullnames": [ + "Assessment", + "ScoreRangeId" + ], + "documentPathsMapping": { + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "ScoreRangeId": [ + "$.scoreRangeId" + ], + "AssessmentReportingMethod": [ + "$.assessmentReportingMethodDescriptor" + ], + "MinimumScore": [ + "$.minimumScore" + ], + "MaximumScore": [ + "$.maximumScore" + ], + "ObjectiveAssessment": [ + "$.objectiveAssessmentReference.assessmentIdentifier", + "$.objectiveAssessmentReference.identificationCode", + "$.objectiveAssessmentReference.namespace" + ] + } + }, + "bellSchedules": { + "resourceName": "BellSchedule", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BellSchedule", + "description": "This entity represents the schedule of class period meeting times.", + "type": "object", + "properties": { + "bellScheduleName": { + "type": "string", + "description": "Name or title of the BellSchedule.", + "minLength": 1, + "maxLength": 60 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "dates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The dates for which the BellSchedule applies." + } + }, + "additionalProperties": false, + "required": [ + "date" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "alternateDayName": { + "type": "string", + "description": "An alternate name for the day (e.g., Red, Blue).", + "minLength": 1, + "maxLength": 20 + }, + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule ends." + }, + "totalInstructionalTime": { + "type": "integer", + "description": "The total instructional time in minutes per day for the bell schedule." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "bellScheduleName", + "schoolReference", + "classPeriods" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BellSchedule", + "description": "This entity represents the schedule of class period meeting times.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "bellScheduleName": { + "type": "string", + "description": "Name or title of the BellSchedule.", + "minLength": 1, + "maxLength": 60 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "dates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The dates for which the BellSchedule applies." + } + }, + "additionalProperties": false, + "required": [ + "date" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "alternateDayName": { + "type": "string", + "description": "An alternate name for the day (e.g., Red, Blue).", + "minLength": 1, + "maxLength": 20 + }, + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule ends." + }, + "totalInstructionalTime": { + "type": "integer", + "description": "The total instructional time in minutes per day for the bell schedule." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "bellScheduleName", + "schoolReference", + "classPeriods" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BellSchedule", + "description": "This entity represents the schedule of class period meeting times.", + "type": "object", + "properties": { + "bellScheduleName": { + "type": "string", + "description": "Name or title of the BellSchedule.", + "minLength": 1, + "maxLength": 60 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "dates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The dates for which the BellSchedule applies." + } + }, + "additionalProperties": false, + "required": [ + "date" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "alternateDayName": { + "type": "string", + "description": "An alternate name for the day (e.g., Red, Blue).", + "minLength": 1, + "maxLength": 20 + }, + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule ends." + }, + "totalInstructionalTime": { + "type": "integer", + "description": "The total instructional time in minutes per day for the bell schedule." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.classPeriods[*].classPeriodReference.schoolId", + "targetJsonPath": "$.schoolReference.schoolId" + } + ], + "identityFullnames": [ + "BellScheduleName", + "School" + ], + "documentPathsMapping": { + "BellScheduleName": [ + "$.bellScheduleName" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "ClassPeriod": [ + "$.classPeriods[*].classPeriodReference.classPeriodName", + "$.classPeriods[*].classPeriodReference.schoolId" + ], + "Date": [ + "$.dates[*].date" + ], + "AlternateDayName": [ + "$.alternateDayName" + ], + "StartTime": [ + "$.startTime" + ], + "EndTime": [ + "$.endTime" + ], + "TotalInstructionalTime": [ + "$.totalInstructionalTime" + ] + } + }, + "budgets": { + "resourceName": "Budget", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Budget", + "description": "This financial entity represents the amount of monies allocated to be spent or received by an education organization as related to a specific account.", + "type": "object", + "properties": { + "amount": { + "type": "number", + "description": "Amount budgeted for the account for this fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported budget element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "amount", + "asOfDate", + "accountReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Budget", + "description": "This financial entity represents the amount of monies allocated to be spent or received by an education organization as related to a specific account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "amount": { + "type": "number", + "description": "Amount budgeted for the account for this fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported budget element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "amount", + "asOfDate", + "accountReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Budget", + "description": "This financial entity represents the amount of monies allocated to be spent or received by an education organization as related to a specific account.", + "type": "object", + "properties": { + "amount": { + "type": "number", + "description": "Amount budgeted for the account for this fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported budget element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "AsOfDate", + "Account" + ], + "documentPathsMapping": { + "Amount": [ + "$.amount" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Account": [ + "$.accountReference.accountIdentifier", + "$.accountReference.educationOrganizationId", + "$.accountReference.fiscalYear" + ] + } + }, + "calendars": { + "resourceName": "Calendar", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Calendar", + "description": "A set of dates associated with an organization.", + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "calendarTypeDescriptor": { + "type": "string", + "description": "Indicates the type of Calendar." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "calendarTypeDescriptor", + "schoolReference", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Calendar", + "description": "A set of dates associated with an organization.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "calendarTypeDescriptor": { + "type": "string", + "description": "Indicates the type of Calendar." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "calendarCode", + "calendarTypeDescriptor", + "schoolReference", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Calendar", + "description": "A set of dates associated with an organization.", + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "calendarTypeDescriptor": { + "type": "string", + "description": "Indicates the type of Calendar." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CalendarCode", + "School", + "SchoolYear" + ], + "documentPathsMapping": { + "CalendarCode": [ + "$.calendarCode" + ], + "CalendarType": [ + "$.calendarTypeDescriptor" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ] + } + }, + "calendarDates": { + "resourceName": "CalendarDate", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CalendarDate", + "description": "The type of scheduled or unscheduled event for the day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the CalendarEvent." + }, + "calendarEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "calendarEventDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "calendarEventDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "calendarReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "date", + "calendarEvents", + "calendarReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CalendarDate", + "description": "The type of scheduled or unscheduled event for the day.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the CalendarEvent." + }, + "calendarEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "calendarEventDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "calendarEventDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "calendarReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "date", + "calendarEvents", + "calendarReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CalendarDate", + "description": "The type of scheduled or unscheduled event for the day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the CalendarEvent." + }, + "calendarEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "calendarEventDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "calendarEventDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "calendarReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Date", + "Calendar" + ], + "documentPathsMapping": { + "Date": [ + "$.date" + ], + "CalendarEvent": [ + "$.calendarEvents[*].calendarEventDescriptor" + ], + "Calendar": [ + "$.calendarReference.calendarCode", + "$.calendarReference.schoolId", + "$.calendarReference.schoolYear" + ] + } + }, + "classPeriods": { + "resourceName": "ClassPeriod", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ClassPeriod", + "description": "This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a Section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "classPeriodName" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ClassPeriod", + "description": "This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a Section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "classPeriodName" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ClassPeriod", + "description": "This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a Section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "ClassPeriodName" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "ClassPeriodName": [ + "$.classPeriodName" + ], + "OfficialAttendancePeriod": [ + "$.officialAttendancePeriod" + ] + } + }, + "cohorts": { + "resourceName": "Cohort", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Cohort", + "description": "This entity represents any type of list of designated students for tracking, analysis, or intervention.", + "type": "object", + "properties": { + "cohortIdentifier": { + "type": "string", + "description": "The name or ID for the Cohort.", + "minLength": 1, + "maxLength": 20 + }, + "cohortDescription": { + "type": "string", + "description": "The description of the Cohort and its purpose.", + "minLength": 1, + "maxLength": 1024 + }, + "cohortTypeDescriptor": { + "type": "string", + "description": "The type of cohort (e.g., academic intervention, classroom breakout)." + }, + "cohortScopeDescriptor": { + "type": "string", + "description": "The scope of cohort (e.g., school, district, classroom)." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The academic subject associated with an academic intervention." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "cohortIdentifier", + "cohortTypeDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Cohort", + "description": "This entity represents any type of list of designated students for tracking, analysis, or intervention.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "cohortIdentifier": { + "type": "string", + "description": "The name or ID for the Cohort.", + "minLength": 1, + "maxLength": 20 + }, + "cohortDescription": { + "type": "string", + "description": "The description of the Cohort and its purpose.", + "minLength": 1, + "maxLength": 1024 + }, + "cohortTypeDescriptor": { + "type": "string", + "description": "The type of cohort (e.g., academic intervention, classroom breakout)." + }, + "cohortScopeDescriptor": { + "type": "string", + "description": "The scope of cohort (e.g., school, district, classroom)." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The academic subject associated with an academic intervention." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "cohortIdentifier", + "cohortTypeDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Cohort", + "description": "This entity represents any type of list of designated students for tracking, analysis, or intervention.", + "type": "object", + "properties": { + "cohortIdentifier": { + "type": "string", + "description": "The name or ID for the Cohort.", + "minLength": 1, + "maxLength": 20 + }, + "cohortDescription": { + "type": "string", + "description": "The description of the Cohort and its purpose.", + "minLength": 1, + "maxLength": 1024 + }, + "cohortTypeDescriptor": { + "type": "string", + "description": "The type of cohort (e.g., academic intervention, classroom breakout)." + }, + "cohortScopeDescriptor": { + "type": "string", + "description": "The scope of cohort (e.g., school, district, classroom)." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The academic subject associated with an academic intervention." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CohortIdentifier", + "EducationOrganization" + ], + "documentPathsMapping": { + "CohortIdentifier": [ + "$.cohortIdentifier" + ], + "CohortDescription": [ + "$.cohortDescription" + ], + "CohortType": [ + "$.cohortTypeDescriptor" + ], + "CohortScope": [ + "$.cohortScopeDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "Program": [ + "$.programs[*].programReference.educationOrganizationId", + "$.programs[*].programReference.programName", + "$.programs[*].programReference.programTypeDescriptor" + ] + } + }, + "communityProviderLicenses": { + "resourceName": "CommunityProviderLicense", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProviderLicense", + "description": "The legal document held by the CommunityProvider that authorizes the holder to perform certain functions and or services.", + "type": "object", + "properties": { + "communityProviderReference": { + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a CommunityProvider." + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId" + ] + }, + "licenseIdentifier": { + "type": "string", + "description": "The unique identifier issued by the licensing organization.", + "maxLength": 20 + }, + "licensingOrganization": { + "type": "string", + "description": "The organization issuing the license.", + "minLength": 1, + "maxLength": 75 + }, + "licenseEffectiveDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license is active or becomes effective." + }, + "licenseExpirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license will expire." + }, + "licenseIssueDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active license was issued." + }, + "licenseStatusDescriptor": { + "type": "string", + "description": "An indication of the status of the license." + }, + "licenseTypeDescriptor": { + "type": "string", + "description": "An indication of the category of the license." + }, + "authorizedFacilityCapacity": { + "type": "integer", + "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve." + }, + "oldestAgeAuthorizedToServe": { + "type": "integer", + "description": "The oldest age of children a provider is authorized or licensed to serve." + }, + "youngestAgeAuthorizedToServe": { + "type": "integer", + "description": "The youngest age of children a provider is authorized or licensed to serve." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "communityProviderReference", + "licenseIdentifier", + "licensingOrganization", + "licenseEffectiveDate", + "licenseTypeDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProviderLicense", + "description": "The legal document held by the CommunityProvider that authorizes the holder to perform certain functions and or services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "communityProviderReference": { + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a CommunityProvider." + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId" + ] + }, + "licenseIdentifier": { + "type": "string", + "description": "The unique identifier issued by the licensing organization.", + "maxLength": 20 + }, + "licensingOrganization": { + "type": "string", + "description": "The organization issuing the license.", + "minLength": 1, + "maxLength": 75 + }, + "licenseEffectiveDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license is active or becomes effective." + }, + "licenseExpirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license will expire." + }, + "licenseIssueDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active license was issued." + }, + "licenseStatusDescriptor": { + "type": "string", + "description": "An indication of the status of the license." + }, + "licenseTypeDescriptor": { + "type": "string", + "description": "An indication of the category of the license." + }, + "authorizedFacilityCapacity": { + "type": "integer", + "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve." + }, + "oldestAgeAuthorizedToServe": { + "type": "integer", + "description": "The oldest age of children a provider is authorized or licensed to serve." + }, + "youngestAgeAuthorizedToServe": { + "type": "integer", + "description": "The youngest age of children a provider is authorized or licensed to serve." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "communityProviderReference", + "licenseIdentifier", + "licensingOrganization", + "licenseEffectiveDate", + "licenseTypeDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProviderLicense", + "description": "The legal document held by the CommunityProvider that authorizes the holder to perform certain functions and or services.", + "type": "object", + "properties": { + "communityProviderReference": { + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a CommunityProvider." + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId" + ] + }, + "licenseIdentifier": { + "type": "string", + "description": "The unique identifier issued by the licensing organization.", + "maxLength": 20 + }, + "licensingOrganization": { + "type": "string", + "description": "The organization issuing the license.", + "minLength": 1, + "maxLength": 75 + }, + "licenseEffectiveDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license is active or becomes effective." + }, + "licenseExpirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license will expire." + }, + "licenseIssueDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active license was issued." + }, + "licenseStatusDescriptor": { + "type": "string", + "description": "An indication of the status of the license." + }, + "licenseTypeDescriptor": { + "type": "string", + "description": "An indication of the category of the license." + }, + "authorizedFacilityCapacity": { + "type": "integer", + "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve." + }, + "oldestAgeAuthorizedToServe": { + "type": "integer", + "description": "The oldest age of children a provider is authorized or licensed to serve." + }, + "youngestAgeAuthorizedToServe": { + "type": "integer", + "description": "The youngest age of children a provider is authorized or licensed to serve." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CommunityProvider" + ], + "documentPathsMapping": { + "CommunityProvider": [ + "$.communityProviderReference.communityProviderId" + ] + } + }, + "competencyObjectives": { + "resourceName": "CompetencyObjective", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CompetencyObjective", + "description": "This entity holds additional competencies for student achievement that are not associated with specific learning objectives (e.g., paying attention in class).", + "type": "object", + "properties": { + "competencyObjectiveId": { + "type": "string", + "description": "The Identifier for the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the student competency objective.", + "minLength": 1, + "maxLength": 1024 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "successCriteria": { + "type": "string", + "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency 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 CompetencyObjective.", + "minLength": 1, + "maxLength": 150 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "objective", + "objectiveGradeLevelDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CompetencyObjective", + "description": "This entity holds additional competencies for student achievement that are not associated with specific learning objectives (e.g., paying attention in class).", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "competencyObjectiveId": { + "type": "string", + "description": "The Identifier for the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the student competency objective.", + "minLength": 1, + "maxLength": 1024 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "successCriteria": { + "type": "string", + "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency 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 CompetencyObjective.", + "minLength": 1, + "maxLength": 150 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "objective", + "objectiveGradeLevelDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CompetencyObjective", + "description": "This entity holds additional competencies for student achievement that are not associated with specific learning objectives (e.g., paying attention in class).", + "type": "object", + "properties": { + "competencyObjectiveId": { + "type": "string", + "description": "The Identifier for the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the student competency objective.", + "minLength": 1, + "maxLength": 1024 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "successCriteria": { + "type": "string", + "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency 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 CompetencyObjective.", + "minLength": 1, + "maxLength": 150 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Objective", + "ObjectiveGradeLevel", + "EducationOrganization" + ], + "documentPathsMapping": { + "CompetencyObjectiveId": [ + "$.competencyObjectiveId" + ], + "Objective": [ + "$.objective" + ], + "Description": [ + "$.description" + ], + "ObjectiveGradeLevel": [ + "$.objectiveGradeLevelDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "SuccessCriteria": [ + "$.successCriteria" + ] + } + }, + "contractedStaffs": { + "resourceName": "ContractedStaff", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ContractedStaff", + "description": "This financial entity represents the sum of the financial transactions to date for contracted staff. ContractedStaff includes \"contractors\" or \"consultants\" who perform services for an agreed upon fee, or an employee of a management service contracted to work on site.", + "type": "object", + "properties": { + "amountToDate": { + "type": "number", + "description": "Current balance (amount paid to contractor) for account for the fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported contracted staff element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "amountToDate", + "asOfDate", + "accountReference", + "staffReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ContractedStaff", + "description": "This financial entity represents the sum of the financial transactions to date for contracted staff. ContractedStaff includes \"contractors\" or \"consultants\" who perform services for an agreed upon fee, or an employee of a management service contracted to work on site.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "amountToDate": { + "type": "number", + "description": "Current balance (amount paid to contractor) for account for the fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported contracted staff element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "amountToDate", + "asOfDate", + "accountReference", + "staffReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ContractedStaff", + "description": "This financial entity represents the sum of the financial transactions to date for contracted staff. ContractedStaff includes \"contractors\" or \"consultants\" who perform services for an agreed upon fee, or an employee of a management service contracted to work on site.", + "type": "object", + "properties": { + "amountToDate": { + "type": "number", + "description": "Current balance (amount paid to contractor) for account for the fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported contracted staff element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "AsOfDate", + "Account", + "Staff" + ], + "documentPathsMapping": { + "AmountToDate": [ + "$.amountToDate" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Account": [ + "$.accountReference.accountIdentifier", + "$.accountReference.educationOrganizationId", + "$.accountReference.fiscalYear" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "courses": { + "resourceName": "Course", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Course", + "description": "This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.", + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", + "minLength": 1, + "maxLength": 60 + }, + "numberOfParts": { + "type": "integer", + "description": "The number of parts identified for a course.", + "minimum": 1, + "maximum": 8 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "levelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the course." + }, + "courseDescription": { + "type": "string", + "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", + "minLength": 1, + "maxLength": 1024 + }, + "timeRequiredForCompletion": { + "type": "integer", + "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", + "minimum": 1 + }, + "dateCourseAdopted": { + "type": "string", + "format": "date", + "description": "Date the course was adopted by the education agency." + }, + "highSchoolCourseRequirement": { + "type": "boolean", + "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area." + }, + "courseGPAApplicabilityDescriptor": { + "type": "string", + "description": "An indicator of whether or not the course being described is included in the computation of the student's Grade Point Average, and if so, if it is weighted differently from regular courses." + }, + "courseDefinedByDescriptor": { + "type": "string", + "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization." + }, + "minimumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "maximumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "careerPathwayDescriptor": { + "type": "string", + "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum." + }, + "competencyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "competencyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "competencyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "maxCompletionsForCredit": { + "type": "integer", + "description": "Designates how many times the course may be taken with credit received by the student.", + "minimum": 1 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "courseTitle", + "numberOfParts", + "identificationCodes", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Course", + "description": "This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", + "minLength": 1, + "maxLength": 60 + }, + "numberOfParts": { + "type": "integer", + "description": "The number of parts identified for a course.", + "minimum": 1, + "maximum": 8 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "levelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the course." + }, + "courseDescription": { + "type": "string", + "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", + "minLength": 1, + "maxLength": 1024 + }, + "timeRequiredForCompletion": { + "type": "integer", + "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", + "minimum": 1 + }, + "dateCourseAdopted": { + "type": "string", + "format": "date", + "description": "Date the course was adopted by the education agency." + }, + "highSchoolCourseRequirement": { + "type": "boolean", + "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area." + }, + "courseGPAApplicabilityDescriptor": { + "type": "string", + "description": "An indicator of whether or not the course being described is included in the computation of the student's Grade Point Average, and if so, if it is weighted differently from regular courses." + }, + "courseDefinedByDescriptor": { + "type": "string", + "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization." + }, + "minimumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "maximumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "careerPathwayDescriptor": { + "type": "string", + "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum." + }, + "competencyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "competencyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "competencyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "maxCompletionsForCredit": { + "type": "integer", + "description": "Designates how many times the course may be taken with credit received by the student.", + "minimum": 1 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "courseCode", + "courseTitle", + "numberOfParts", + "identificationCodes", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Course", + "description": "This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.", + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", + "minLength": 1, + "maxLength": 60 + }, + "numberOfParts": { + "type": "integer", + "description": "The number of parts identified for a course.", + "minimum": 1, + "maximum": 8 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "levelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the course." + }, + "courseDescription": { + "type": "string", + "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", + "minLength": 1, + "maxLength": 1024 + }, + "timeRequiredForCompletion": { + "type": "integer", + "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", + "minimum": 1 + }, + "dateCourseAdopted": { + "type": "string", + "format": "date", + "description": "Date the course was adopted by the education agency." + }, + "highSchoolCourseRequirement": { + "type": "boolean", + "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area." + }, + "courseGPAApplicabilityDescriptor": { + "type": "string", + "description": "An indicator of whether or not the course being described is included in the computation of the student's Grade Point Average, and if so, if it is weighted differently from regular courses." + }, + "courseDefinedByDescriptor": { + "type": "string", + "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization." + }, + "minimumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "maximumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "careerPathwayDescriptor": { + "type": "string", + "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum." + }, + "competencyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "competencyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "competencyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "maxCompletionsForCredit": { + "type": "integer", + "description": "Designates how many times the course may be taken with credit received by the student.", + "minimum": 1 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CourseCode", + "EducationOrganization" + ], + "documentPathsMapping": { + "CourseCode": [ + "$.courseCode" + ], + "CourseTitle": [ + "$.courseTitle" + ], + "NumberOfParts": [ + "$.numberOfParts" + ], + "CourseLevelCharacteristic": [ + "$.levelCharacteristics[*].courseLevelCharacteristicDescriptor" + ], + "OfferedGradeLevel": [ + "$.offeredGradeLevels[*].gradeLevelDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ], + "CourseDescription": [ + "$.courseDescription" + ], + "TimeRequiredForCompletion": [ + "$.timeRequiredForCompletion" + ], + "DateCourseAdopted": [ + "$.dateCourseAdopted" + ], + "HighSchoolCourseRequirement": [ + "$.highSchoolCourseRequirement" + ], + "CourseGPAApplicability": [ + "$.courseGPAApplicabilityDescriptor" + ], + "CourseDefinedBy": [ + "$.courseDefinedByDescriptor" + ], + "CareerPathway": [ + "$.careerPathwayDescriptor" + ], + "CompetencyLevel": [ + "$.competencyLevels[*].competencyLevelDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "LearningObjective": [ + "$.learningObjectives[*].learningObjectiveReference.learningObjectiveId", + "$.learningObjectives[*].learningObjectiveReference.namespace" + ], + "MaxCompletionsForCredit": [ + "$.maxCompletionsForCredit" + ] + } + }, + "courseOfferings": { + "resourceName": "CourseOffering", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseOffering", + "description": "This entity represents an entry in the course catalog of available courses offered by the school during a session.", + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "instructionalTimePlanned": { + "type": "integer", + "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", + "minimum": 1 + }, + "curriculumUseds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "curriculumUsedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "curriculumUsedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolReference", + "sessionReference", + "courseReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseOffering", + "description": "This entity represents an entry in the course catalog of available courses offered by the school during a session.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "instructionalTimePlanned": { + "type": "integer", + "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", + "minimum": 1 + }, + "curriculumUseds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "curriculumUsedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "curriculumUsedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "localCourseCode", + "schoolReference", + "sessionReference", + "courseReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseOffering", + "description": "This entity represents an entry in the course catalog of available courses offered by the school during a session.", + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "instructionalTimePlanned": { + "type": "integer", + "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", + "minimum": 1 + }, + "curriculumUseds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "curriculumUsedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "curriculumUsedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.schoolReference.schoolId", + "targetJsonPath": "$.sessionReference.schoolId" + } + ], + "identityFullnames": [ + "LocalCourseCode", + "School", + "Session" + ], + "documentPathsMapping": { + "LocalCourseCode": [ + "$.localCourseCode" + ], + "LocalCourseTitle": [ + "$.localCourseTitle" + ], + "InstructionalTimePlanned": [ + "$.instructionalTimePlanned" + ], + "CurriculumUsed": [ + "$.curriculumUseds[*].curriculumUsedDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "Session": [ + "$.sessionReference.schoolId", + "$.sessionReference.schoolYear", + "$.sessionReference.sessionName" + ], + "Course": [ + "$.courseReference.courseCode", + "$.courseReference.educationOrganizationId" + ], + "CourseLevelCharacteristic": [ + "$.courseLevelCharacteristics[*].courseLevelCharacteristicDescriptor" + ], + "OfferedGradeLevel": [ + "$.offeredGradeLevels[*].gradeLevelDescriptor" + ] + } + }, + "courseTranscripts": { + "resourceName": "CourseTranscript", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseTranscript", + "description": "This entity is the final record of a student's performance in their courses at the end of a semester or school year.", + "type": "object", + "properties": { + "courseAttemptResultDescriptor": { + "type": "string", + "description": "The result from the student's attempt to take the course, for example: Pass Fail Incomplete Withdrawn." + }, + "attemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "earnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "earnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedAdditionalCredits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course" + }, + "additionalCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + } + }, + "additionalProperties": false, + "required": [ + "credits", + "additionalCreditTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "Student's grade level at time of course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned (e.g., Classroom, Examination, Transfer)." + }, + "finalLetterGradeEarned": { + "type": "string", + "description": "The final indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "finalNumericGradeEarned": { + "type": "number", + "description": "The final indicator of student performance in a class as submitted by the instructor." + }, + "courseRepeatCodeDescriptor": { + "type": "string", + "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average." + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "studentAcademicRecordReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ] + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseCode": { + "type": "string", + "description": "The local code assigned by the school that identifies the course offering, the code from an external educational organization, or other alternate course code.", + "minLength": 1, + "maxLength": 60 + }, + "externalEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "externalEducationOrganizationNameOfInstitution": { + "type": "string", + "description": "Name of the external institution where the student completed the course; to be used only when the reference ExternalEducationOrganization is not available.", + "minLength": 1, + "maxLength": 75 + }, + "alternativeCourseIdentificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the course identification code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + }, + "creditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "partialCourseTranscriptAwards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "awardDate": { + "type": "string", + "format": "date", + "description": "The date the partial credits and/or grades were awarded or earned." + }, + "earnedCredits": { + "type": "number", + "description": "The number of credits a student earned for completing a given course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "letterGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + } + }, + "additionalProperties": false, + "required": [ + "awardDate", + "earnedCredits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "courseAttemptResultDescriptor", + "earnedCredits", + "courseReference", + "studentAcademicRecordReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseTranscript", + "description": "This entity is the final record of a student's performance in their courses at the end of a semester or school year.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "courseAttemptResultDescriptor": { + "type": "string", + "description": "The result from the student's attempt to take the course, for example: Pass Fail Incomplete Withdrawn." + }, + "attemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "earnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "earnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedAdditionalCredits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course" + }, + "additionalCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + } + }, + "additionalProperties": false, + "required": [ + "credits", + "additionalCreditTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "Student's grade level at time of course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned (e.g., Classroom, Examination, Transfer)." + }, + "finalLetterGradeEarned": { + "type": "string", + "description": "The final indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "finalNumericGradeEarned": { + "type": "number", + "description": "The final indicator of student performance in a class as submitted by the instructor." + }, + "courseRepeatCodeDescriptor": { + "type": "string", + "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average." + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "studentAcademicRecordReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ] + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseCode": { + "type": "string", + "description": "The local code assigned by the school that identifies the course offering, the code from an external educational organization, or other alternate course code.", + "minLength": 1, + "maxLength": 60 + }, + "externalEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "externalEducationOrganizationNameOfInstitution": { + "type": "string", + "description": "Name of the external institution where the student completed the course; to be used only when the reference ExternalEducationOrganization is not available.", + "minLength": 1, + "maxLength": 75 + }, + "alternativeCourseIdentificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the course identification code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + }, + "creditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "partialCourseTranscriptAwards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "awardDate": { + "type": "string", + "format": "date", + "description": "The date the partial credits and/or grades were awarded or earned." + }, + "earnedCredits": { + "type": "number", + "description": "The number of credits a student earned for completing a given course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "letterGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + } + }, + "additionalProperties": false, + "required": [ + "awardDate", + "earnedCredits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "courseAttemptResultDescriptor", + "earnedCredits", + "courseReference", + "studentAcademicRecordReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseTranscript", + "description": "This entity is the final record of a student's performance in their courses at the end of a semester or school year.", + "type": "object", + "properties": { + "courseAttemptResultDescriptor": { + "type": "string", + "description": "The result from the student's attempt to take the course, for example: Pass Fail Incomplete Withdrawn." + }, + "attemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "earnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "earnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedAdditionalCredits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course" + }, + "additionalCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + } + }, + "additionalProperties": false, + "required": [ + "credits", + "additionalCreditTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "Student's grade level at time of course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned (e.g., Classroom, Examination, Transfer)." + }, + "finalLetterGradeEarned": { + "type": "string", + "description": "The final indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "finalNumericGradeEarned": { + "type": "number", + "description": "The final indicator of student performance in a class as submitted by the instructor." + }, + "courseRepeatCodeDescriptor": { + "type": "string", + "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average." + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "studentAcademicRecordReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ] + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseCode": { + "type": "string", + "description": "The local code assigned by the school that identifies the course offering, the code from an external educational organization, or other alternate course code.", + "minLength": 1, + "maxLength": 60 + }, + "externalEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "externalEducationOrganizationNameOfInstitution": { + "type": "string", + "description": "Name of the external institution where the student completed the course; to be used only when the reference ExternalEducationOrganization is not available.", + "minLength": 1, + "maxLength": 75 + }, + "alternativeCourseIdentificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the course identification code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + }, + "creditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "partialCourseTranscriptAwards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "awardDate": { + "type": "string", + "format": "date", + "description": "The date the partial credits and/or grades were awarded or earned." + }, + "earnedCredits": { + "type": "number", + "description": "The number of credits a student earned for completing a given course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "letterGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + } + }, + "additionalProperties": false, + "required": [ + "awardDate", + "earnedCredits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CourseAttemptResult", + "Course", + "StudentAcademicRecord" + ], + "documentPathsMapping": { + "CourseAttemptResult": [ + "$.courseAttemptResultDescriptor" + ], + "WhenTakenGradeLevel": [ + "$.whenTakenGradeLevelDescriptor" + ], + "MethodCreditEarned": [ + "$.methodCreditEarnedDescriptor" + ], + "FinalLetterGradeEarned": [ + "$.finalLetterGradeEarned" + ], + "FinalNumericGradeEarned": [ + "$.finalNumericGradeEarned" + ], + "CourseRepeatCode": [ + "$.courseRepeatCodeDescriptor" + ], + "Course": [ + "$.courseReference.courseCode", + "$.courseReference.educationOrganizationId" + ], + "StudentAcademicRecord": [ + "$.studentAcademicRecordReference.educationOrganizationId", + "$.studentAcademicRecordReference.schoolYear", + "$.studentAcademicRecordReference.studentUniqueId", + "$.studentAcademicRecordReference.termDescriptor" + ], + "CourseTitle": [ + "$.courseTitle" + ], + "AlternativeCourseTitle": [ + "$.alternativeCourseTitle" + ], + "AlternativeCourseCode": [ + "$.alternativeCourseCode" + ], + "ExternalEducationOrganization": [ + "$.externalEducationOrganizationReference.educationOrganizationId" + ], + "ExternalEducationOrganizationNameOfInstitution": [ + "$.externalEducationOrganizationNameOfInstitution" + ], + "AssigningOrganizationIdentificationCode": [ + "$.assigningOrganizationIdentificationCode" + ], + "CourseCatalogURL": [ + "$.courseCatalogURL" + ], + "CreditCategory": [ + "$.creditCategories[*].creditCategoryDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ] + } + }, + "credentials": { + "resourceName": "Credential", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Credential", + "description": "The legal document giving authorization to perform teaching assignment services.", + "type": "object", + "properties": { + "effectiveDate": { + "type": "string", + "format": "date", + "description": "The year, month and day on which an active credential held by an individual was issued." + }, + "endorsements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "endorsement": { + "type": "string", + "description": "Endorsements are attachments to teaching certificates and indicate areas of specialization.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "endorsement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential held by an individual will expire." + }, + "credentialFieldDescriptor": { + "type": "string", + "description": "The field of certification for the certificate (e.g., Mathematics, Music)." + }, + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "issuanceDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential was issued to an individual." + }, + "credentialTypeDescriptor": { + "type": "string", + "description": "An indication of the category of credential an individual holds." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + }, + "teachingCredentialDescriptor": { + "type": "string", + "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services." + }, + "teachingCredentialBasisDescriptor": { + "type": "string", + "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the Credential.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "issuanceDate", + "credentialTypeDescriptor", + "stateOfIssueStateAbbreviationDescriptor", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Credential", + "description": "The legal document giving authorization to perform teaching assignment services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "effectiveDate": { + "type": "string", + "format": "date", + "description": "The year, month and day on which an active credential held by an individual was issued." + }, + "endorsements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "endorsement": { + "type": "string", + "description": "Endorsements are attachments to teaching certificates and indicate areas of specialization.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "endorsement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential held by an individual will expire." + }, + "credentialFieldDescriptor": { + "type": "string", + "description": "The field of certification for the certificate (e.g., Mathematics, Music)." + }, + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "issuanceDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential was issued to an individual." + }, + "credentialTypeDescriptor": { + "type": "string", + "description": "An indication of the category of credential an individual holds." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + }, + "teachingCredentialDescriptor": { + "type": "string", + "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services." + }, + "teachingCredentialBasisDescriptor": { + "type": "string", + "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the Credential.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "credentialIdentifier", + "issuanceDate", + "credentialTypeDescriptor", + "stateOfIssueStateAbbreviationDescriptor", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Credential", + "description": "The legal document giving authorization to perform teaching assignment services.", + "type": "object", + "properties": { + "effectiveDate": { + "type": "string", + "format": "date", + "description": "The year, month and day on which an active credential held by an individual was issued." + }, + "endorsements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "endorsement": { + "type": "string", + "description": "Endorsements are attachments to teaching certificates and indicate areas of specialization.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "endorsement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential held by an individual will expire." + }, + "credentialFieldDescriptor": { + "type": "string", + "description": "The field of certification for the certificate (e.g., Mathematics, Music)." + }, + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "issuanceDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential was issued to an individual." + }, + "credentialTypeDescriptor": { + "type": "string", + "description": "An indication of the category of credential an individual holds." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + }, + "teachingCredentialDescriptor": { + "type": "string", + "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services." + }, + "teachingCredentialBasisDescriptor": { + "type": "string", + "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the Credential.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CredentialIdentifier", + "StateOfIssueStateAbbreviation" + ], + "documentPathsMapping": { + "EffectiveDate": [ + "$.effectiveDate" + ], + "CredentialEndorsement": [ + "$.endorsements[*].endorsement" + ], + "ExpirationDate": [ + "$.expirationDate" + ], + "CredentialField": [ + "$.credentialFieldDescriptor" + ], + "CredentialIdentifier": [ + "$.credentialIdentifier" + ], + "IssuanceDate": [ + "$.issuanceDate" + ], + "CredentialType": [ + "$.credentialTypeDescriptor" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "StateOfIssueStateAbbreviation": [ + "$.stateOfIssueStateAbbreviationDescriptor" + ], + "TeachingCredential": [ + "$.teachingCredentialDescriptor" + ], + "TeachingCredentialBasis": [ + "$.teachingCredentialBasisDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "Namespace": [ + "$.namespace" + ] + } + }, + "disciplineActions": { + "resourceName": "DisciplineAction", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineAction", + "description": "This event entity represents actions taken by an education organization after a disruptive event that is recorded as a discipline incident.", + "type": "object", + "properties": { + "disciplineActionIdentifier": { + "type": "string", + "description": "Identifier assigned by the education organization to the DisciplineAction.", + "minLength": 1, + "maxLength": 20 + }, + "disciplines": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disciplineDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disciplineDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "disciplineDate": { + "type": "string", + "format": "date", + "description": "The date of the DisciplineAction." + }, + "disciplineActionLength": { + "type": "number", + "description": "The length of time in school days for the DisciplineAction (e.g. removal, detention), if applicable." + }, + "actualDisciplineActionLength": { + "type": "number", + "description": "Indicates the actual length in school days of a student's disciplinary assignment." + }, + "disciplineActionLengthDifferenceReasonDescriptor": { + "type": "string", + "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment." + }, + "relatedToZeroTolerancePolicy": { + "type": "boolean", + "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentDisciplineIncidentAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentAssociationReference": { + "type": "object", + "properties": { + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentAssociationReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "responsibilitySchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "assignmentSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "receivedEducationServicesDuringExpulsion": { + "type": "boolean", + "description": "An indication of whether the student received educational services when removed from the regular school program for disciplinary reasons." + }, + "iepPlacementMeetingIndicator": { + "type": "boolean", + "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement." + }, + "studentDisciplineIncidentBehaviorAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentBehaviorAssociationReference": { + "type": "object", + "properties": { + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category." + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentBehaviorAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "disciplineActionIdentifier", + "disciplines", + "disciplineDate", + "studentReference", + "studentDisciplineIncidentAssociations", + "responsibilitySchoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineAction", + "description": "This event entity represents actions taken by an education organization after a disruptive event that is recorded as a discipline incident.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "disciplineActionIdentifier": { + "type": "string", + "description": "Identifier assigned by the education organization to the DisciplineAction.", + "minLength": 1, + "maxLength": 20 + }, + "disciplines": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disciplineDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disciplineDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "disciplineDate": { + "type": "string", + "format": "date", + "description": "The date of the DisciplineAction." + }, + "disciplineActionLength": { + "type": "number", + "description": "The length of time in school days for the DisciplineAction (e.g. removal, detention), if applicable." + }, + "actualDisciplineActionLength": { + "type": "number", + "description": "Indicates the actual length in school days of a student's disciplinary assignment." + }, + "disciplineActionLengthDifferenceReasonDescriptor": { + "type": "string", + "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment." + }, + "relatedToZeroTolerancePolicy": { + "type": "boolean", + "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentDisciplineIncidentAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentAssociationReference": { + "type": "object", + "properties": { + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentAssociationReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "responsibilitySchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "assignmentSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "receivedEducationServicesDuringExpulsion": { + "type": "boolean", + "description": "An indication of whether the student received educational services when removed from the regular school program for disciplinary reasons." + }, + "iepPlacementMeetingIndicator": { + "type": "boolean", + "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement." + }, + "studentDisciplineIncidentBehaviorAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentBehaviorAssociationReference": { + "type": "object", + "properties": { + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category." + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentBehaviorAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "disciplineActionIdentifier", + "disciplines", + "disciplineDate", + "studentReference", + "studentDisciplineIncidentAssociations", + "responsibilitySchoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineAction", + "description": "This event entity represents actions taken by an education organization after a disruptive event that is recorded as a discipline incident.", + "type": "object", + "properties": { + "disciplineActionIdentifier": { + "type": "string", + "description": "Identifier assigned by the education organization to the DisciplineAction.", + "minLength": 1, + "maxLength": 20 + }, + "disciplines": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disciplineDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disciplineDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "disciplineDate": { + "type": "string", + "format": "date", + "description": "The date of the DisciplineAction." + }, + "disciplineActionLength": { + "type": "number", + "description": "The length of time in school days for the DisciplineAction (e.g. removal, detention), if applicable." + }, + "actualDisciplineActionLength": { + "type": "number", + "description": "Indicates the actual length in school days of a student's disciplinary assignment." + }, + "disciplineActionLengthDifferenceReasonDescriptor": { + "type": "string", + "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment." + }, + "relatedToZeroTolerancePolicy": { + "type": "boolean", + "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentDisciplineIncidentAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentAssociationReference": { + "type": "object", + "properties": { + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentAssociationReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "responsibilitySchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "assignmentSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "receivedEducationServicesDuringExpulsion": { + "type": "boolean", + "description": "An indication of whether the student received educational services when removed from the regular school program for disciplinary reasons." + }, + "iepPlacementMeetingIndicator": { + "type": "boolean", + "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement." + }, + "studentDisciplineIncidentBehaviorAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentBehaviorAssociationReference": { + "type": "object", + "properties": { + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category." + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentBehaviorAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.studentDisciplineIncidentAssociations[*].studentDisciplineIncidentAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + }, + { + "sourceJsonPath": "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "DisciplineActionIdentifier", + "DisciplineDate", + "Student" + ], + "documentPathsMapping": { + "DisciplineActionIdentifier": [ + "$.disciplineActionIdentifier" + ], + "Discipline": [ + "$.disciplines[*].disciplineDescriptor" + ], + "DisciplineDate": [ + "$.disciplineDate" + ], + "DisciplineActionLength": [ + "$.disciplineActionLength" + ], + "ActualDisciplineActionLength": [ + "$.actualDisciplineActionLength" + ], + "DisciplineActionLengthDifferenceReason": [ + "$.disciplineActionLengthDifferenceReasonDescriptor" + ], + "RelatedToZeroTolerancePolicy": [ + "$.relatedToZeroTolerancePolicy" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "StudentDisciplineIncidentAssociation": [ + "$.studentDisciplineIncidentAssociations[*].studentDisciplineIncidentAssociationReference.incidentIdentifier", + "$.studentDisciplineIncidentAssociations[*].studentDisciplineIncidentAssociationReference.schoolId", + "$.studentDisciplineIncidentAssociations[*].studentDisciplineIncidentAssociationReference.studentUniqueId" + ], + "Staff": [ + "$.staffs[*].staffReference.staffUniqueId" + ], + "ResponsibilitySchool": [ + "$.responsibilitySchoolReference.schoolId" + ], + "AssignmentSchool": [ + "$.assignmentSchoolReference.schoolId" + ], + "ReceivedEducationServicesDuringExpulsion": [ + "$.receivedEducationServicesDuringExpulsion" + ], + "IEPPlacementMeetingIndicator": [ + "$.iepPlacementMeetingIndicator" + ], + "StudentDisciplineIncidentBehaviorAssociation": [ + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.behaviorDescriptor", + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.incidentIdentifier", + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.schoolId", + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.studentUniqueId" + ] + } + }, + "disciplineIncidents": { + "resourceName": "DisciplineIncident", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineIncident", + "description": "This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.", + "type": "object", + "properties": { + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "incidentDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the DisciplineIncident occurred." + }, + "incidentTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the incident took place." + }, + "incidentLocationDescriptor": { + "type": "string", + "description": "Identifies where the DisciplineIncident occurred and whether or not it occurred on school, for example: On school Administrative offices area Cafeteria area Classroom Hallway or stairs ..." + }, + "incidentDescription": { + "type": "string", + "description": "The description for an incident.", + "minLength": 1, + "maxLength": 1024 + }, + "reporterDescriptionDescriptor": { + "type": "string", + "description": "Information on the type of individual who reported the DisciplineIncident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\"); for example: Student Parent/guardian Law enforcement officer Nonschool personnel Representative of visiting school ..." + }, + "reporterName": { + "type": "string", + "description": "Identifies the reporter of the DisciplineIncident by name.", + "minLength": 1, + "maxLength": 75 + }, + "behaviors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "behaviorDetailedDescription": { + "type": "string", + "description": "Specifies a more granular level of detail of a behavior involved in the incident.", + "minLength": 1, + "maxLength": 1024 + }, + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category and provides a detailed description." + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "weapons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "weaponDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "weaponDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "reportedToLawEnforcement": { + "type": "boolean", + "description": "Indicator of whether the incident was reported to law enforcement." + }, + "caseNumber": { + "type": "string", + "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", + "minLength": 1, + "maxLength": 20 + }, + "incidentCost": { + "type": "number", + "description": "The value of any quantifiable monetary loss directly resulting from the DisciplineIncident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident." + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "externalParticipants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "disciplineIncidentParticipationCodeDescriptor": { + "type": "string", + "description": "The role or type of participation of a student in a discipline incident; for example: Victim, Perpetrator, Witness, Reporter." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "disciplineIncidentParticipationCodeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "incidentIdentifier", + "incidentDate", + "schoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineIncident", + "description": "This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "incidentDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the DisciplineIncident occurred." + }, + "incidentTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the incident took place." + }, + "incidentLocationDescriptor": { + "type": "string", + "description": "Identifies where the DisciplineIncident occurred and whether or not it occurred on school, for example: On school Administrative offices area Cafeteria area Classroom Hallway or stairs ..." + }, + "incidentDescription": { + "type": "string", + "description": "The description for an incident.", + "minLength": 1, + "maxLength": 1024 + }, + "reporterDescriptionDescriptor": { + "type": "string", + "description": "Information on the type of individual who reported the DisciplineIncident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\"); for example: Student Parent/guardian Law enforcement officer Nonschool personnel Representative of visiting school ..." + }, + "reporterName": { + "type": "string", + "description": "Identifies the reporter of the DisciplineIncident by name.", + "minLength": 1, + "maxLength": 75 + }, + "behaviors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "behaviorDetailedDescription": { + "type": "string", + "description": "Specifies a more granular level of detail of a behavior involved in the incident.", + "minLength": 1, + "maxLength": 1024 + }, + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category and provides a detailed description." + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "weapons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "weaponDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "weaponDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "reportedToLawEnforcement": { + "type": "boolean", + "description": "Indicator of whether the incident was reported to law enforcement." + }, + "caseNumber": { + "type": "string", + "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", + "minLength": 1, + "maxLength": 20 + }, + "incidentCost": { + "type": "number", + "description": "The value of any quantifiable monetary loss directly resulting from the DisciplineIncident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident." + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "externalParticipants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "disciplineIncidentParticipationCodeDescriptor": { + "type": "string", + "description": "The role or type of participation of a student in a discipline incident; for example: Victim, Perpetrator, Witness, Reporter." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "disciplineIncidentParticipationCodeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "incidentIdentifier", + "incidentDate", + "schoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineIncident", + "description": "This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.", + "type": "object", + "properties": { + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire DisciplineIncident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 20 + }, + "incidentDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the DisciplineIncident occurred." + }, + "incidentTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the incident took place." + }, + "incidentLocationDescriptor": { + "type": "string", + "description": "Identifies where the DisciplineIncident occurred and whether or not it occurred on school, for example: On school Administrative offices area Cafeteria area Classroom Hallway or stairs ..." + }, + "incidentDescription": { + "type": "string", + "description": "The description for an incident.", + "minLength": 1, + "maxLength": 1024 + }, + "reporterDescriptionDescriptor": { + "type": "string", + "description": "Information on the type of individual who reported the DisciplineIncident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\"); for example: Student Parent/guardian Law enforcement officer Nonschool personnel Representative of visiting school ..." + }, + "reporterName": { + "type": "string", + "description": "Identifies the reporter of the DisciplineIncident by name.", + "minLength": 1, + "maxLength": 75 + }, + "behaviors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "behaviorDetailedDescription": { + "type": "string", + "description": "Specifies a more granular level of detail of a behavior involved in the incident.", + "minLength": 1, + "maxLength": 1024 + }, + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category and provides a detailed description." + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "weapons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "weaponDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "weaponDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "reportedToLawEnforcement": { + "type": "boolean", + "description": "Indicator of whether the incident was reported to law enforcement." + }, + "caseNumber": { + "type": "string", + "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", + "minLength": 1, + "maxLength": 20 + }, + "incidentCost": { + "type": "number", + "description": "The value of any quantifiable monetary loss directly resulting from the DisciplineIncident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident." + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "externalParticipants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "disciplineIncidentParticipationCodeDescriptor": { + "type": "string", + "description": "The role or type of participation of a student in a discipline incident; for example: Victim, Perpetrator, Witness, Reporter." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "disciplineIncidentParticipationCodeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "IncidentIdentifier", + "School" + ], + "documentPathsMapping": { + "IncidentIdentifier": [ + "$.incidentIdentifier" + ], + "IncidentDate": [ + "$.incidentDate" + ], + "IncidentTime": [ + "$.incidentTime" + ], + "IncidentLocation": [ + "$.incidentLocationDescriptor" + ], + "IncidentDescription": [ + "$.incidentDescription" + ], + "ReporterDescription": [ + "$.reporterDescriptionDescriptor" + ], + "ReporterName": [ + "$.reporterName" + ], + "Weapon": [ + "$.weapons[*].weaponDescriptor" + ], + "ReportedToLawEnforcement": [ + "$.reportedToLawEnforcement" + ], + "CaseNumber": [ + "$.caseNumber" + ], + "IncidentCost": [ + "$.incidentCost" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "educationContents": { + "resourceName": "EducationContent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationContent", + "description": "This entity represents materials for students or teachers that can be used for teaching, learning, research, and more. Education content includes full courses, course materials, modules, intervention descriptions, textbooks, streaming videos, tests, software, and any other tools, materials, or techniques used to support access to knowledge.", + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + }, + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "shortDescription": { + "type": "string", + "description": "A short description or name of the entity.", + "minLength": 1, + "maxLength": 75 + }, + "description": { + "type": "string", + "description": "An extended written representation of the education content.", + "minLength": 1, + "maxLength": 1024 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The individual credited with the creation of the resource.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "additionalAuthorsIndicator": { + "type": "boolean", + "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\"." + }, + "publisher": { + "type": "string", + "description": "The organization credited with publishing the resource.", + "minLength": 1, + "maxLength": 50 + }, + "timeRequired": { + "type": "number", + "description": "Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience." + }, + "interactivityStyleDescriptor": { + "type": "string", + "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed." + }, + "contentClassDescriptor": { + "type": "string", + "description": "The predominate type or kind characterizing the learning resource." + }, + "useRightsURL": { + "type": "string", + "description": "The URL where the owner specifies permissions for using the resource.", + "minLength": 5, + "maxLength": 255 + }, + "derivativeSourceEducationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceEducationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceEducationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceLearningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceLearningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceLearningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 10 + }, + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false + }, + "cost": { + "type": "number", + "description": "An amount that has to be paid or spent to buy or obtain the EducationContent." + }, + "costRateDescriptor": { + "type": "string", + "description": "The rate by which the cost applies." + }, + "namespace": { + "type": "string", + "description": "Namespace for the EducationContent.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationContent", + "description": "This entity represents materials for students or teachers that can be used for teaching, learning, research, and more. Education content includes full courses, course materials, modules, intervention descriptions, textbooks, streaming videos, tests, software, and any other tools, materials, or techniques used to support access to knowledge.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + }, + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "shortDescription": { + "type": "string", + "description": "A short description or name of the entity.", + "minLength": 1, + "maxLength": 75 + }, + "description": { + "type": "string", + "description": "An extended written representation of the education content.", + "minLength": 1, + "maxLength": 1024 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The individual credited with the creation of the resource.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "additionalAuthorsIndicator": { + "type": "boolean", + "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\"." + }, + "publisher": { + "type": "string", + "description": "The organization credited with publishing the resource.", + "minLength": 1, + "maxLength": 50 + }, + "timeRequired": { + "type": "number", + "description": "Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience." + }, + "interactivityStyleDescriptor": { + "type": "string", + "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed." + }, + "contentClassDescriptor": { + "type": "string", + "description": "The predominate type or kind characterizing the learning resource." + }, + "useRightsURL": { + "type": "string", + "description": "The URL where the owner specifies permissions for using the resource.", + "minLength": 5, + "maxLength": 255 + }, + "derivativeSourceEducationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceEducationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceEducationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceLearningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceLearningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceLearningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 10 + }, + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false + }, + "cost": { + "type": "number", + "description": "An amount that has to be paid or spent to buy or obtain the EducationContent." + }, + "costRateDescriptor": { + "type": "string", + "description": "The rate by which the cost applies." + }, + "namespace": { + "type": "string", + "description": "Namespace for the EducationContent.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "contentIdentifier", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationContent", + "description": "This entity represents materials for students or teachers that can be used for teaching, learning, research, and more. Education content includes full courses, course materials, modules, intervention descriptions, textbooks, streaming videos, tests, software, and any other tools, materials, or techniques used to support access to knowledge.", + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + }, + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "shortDescription": { + "type": "string", + "description": "A short description or name of the entity.", + "minLength": 1, + "maxLength": 75 + }, + "description": { + "type": "string", + "description": "An extended written representation of the education content.", + "minLength": 1, + "maxLength": 1024 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The individual credited with the creation of the resource.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "additionalAuthorsIndicator": { + "type": "boolean", + "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\"." + }, + "publisher": { + "type": "string", + "description": "The organization credited with publishing the resource.", + "minLength": 1, + "maxLength": 50 + }, + "timeRequired": { + "type": "number", + "description": "Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience." + }, + "interactivityStyleDescriptor": { + "type": "string", + "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed." + }, + "contentClassDescriptor": { + "type": "string", + "description": "The predominate type or kind characterizing the learning resource." + }, + "useRightsURL": { + "type": "string", + "description": "The URL where the owner specifies permissions for using the resource.", + "minLength": 5, + "maxLength": 255 + }, + "derivativeSourceEducationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceEducationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceEducationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceLearningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceLearningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceLearningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 10 + }, + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false + }, + "cost": { + "type": "number", + "description": "An amount that has to be paid or spent to buy or obtain the EducationContent." + }, + "costRateDescriptor": { + "type": "string", + "description": "The rate by which the cost applies." + }, + "namespace": { + "type": "string", + "description": "Namespace for the EducationContent.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "ContentIdentifier" + ], + "documentPathsMapping": { + "ContentIdentifier": [ + "$.contentIdentifier" + ], + "Cost": [ + "$.cost" + ], + "CostRate": [ + "$.costRateDescriptor" + ], + "Namespace": [ + "$.namespace" + ] + } + }, + "grades": { + "resourceName": "Grade", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Grade", + "description": "This educational entity represents an overall score or assessment tied to a course over a period of time (i.e., the grading period). Student grades are usually a compilation of marks and other scores.", + "type": "object", + "properties": { + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., Exam, Final, Grading Period)." + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A conversion of the level to a standard set of performance levels." + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandardGrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A performance level that describes the student proficiency." + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "studentSectionAssociationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Grade", + "description": "This educational entity represents an overall score or assessment tied to a course over a period of time (i.e., the grading period). Student grades are usually a compilation of marks and other scores.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., Exam, Final, Grading Period)." + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A conversion of the level to a standard set of performance levels." + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandardGrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A performance level that describes the student proficiency." + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "gradeTypeDescriptor", + "studentSectionAssociationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Grade", + "description": "This educational entity represents an overall score or assessment tied to a course over a period of time (i.e., the grading period). Student grades are usually a compilation of marks and other scores.", + "type": "object", + "properties": { + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., Exam, Final, Grading Period)." + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A conversion of the level to a standard set of performance levels." + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandardGrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A performance level that describes the student proficiency." + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.gradingPeriodReference.schoolId", + "targetJsonPath": "$.studentSectionAssociationReference.schoolId" + }, + { + "sourceJsonPath": "$.gradingPeriodReference.schoolYear", + "targetJsonPath": "$.studentSectionAssociationReference.schoolYear" + } + ], + "identityFullnames": [ + "GradeType", + "StudentSectionAssociation", + "GradingPeriod" + ], + "documentPathsMapping": { + "LetterGradeEarned": [ + "$.letterGradeEarned" + ], + "NumericGradeEarned": [ + "$.numericGradeEarned" + ], + "DiagnosticStatement": [ + "$.diagnosticStatement" + ], + "GradeType": [ + "$.gradeTypeDescriptor" + ], + "PerformanceBaseConversion": [ + "$.performanceBaseConversionDescriptor" + ], + "StudentSectionAssociation": [ + "$.studentSectionAssociationReference.beginDate", + "$.studentSectionAssociationReference.localCourseCode", + "$.studentSectionAssociationReference.schoolId", + "$.studentSectionAssociationReference.schoolYear", + "$.studentSectionAssociationReference.sectionIdentifier", + "$.studentSectionAssociationReference.sessionName", + "$.studentSectionAssociationReference.studentUniqueId" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ] + } + }, + "gradebookEntries": { + "resourceName": "GradebookEntry", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradebookEntry", + "description": "This entity represents an assignment, homework, or classroom assessment to be recorded in a gradebook.", + "type": "object", + "properties": { + "gradebookEntryTitle": { + "type": "string", + "description": "The name or title of the activity to be recorded in the GradebookEntry.", + "minLength": 1, + "maxLength": 60 + }, + "gradebookEntryTypeDescriptor": { + "type": "string", + "description": "The type of the GradebookEntry; for example, homework, assignment, quiz, unit test, oral presentation, etc." + }, + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "description": { + "type": "string", + "description": "A description of the assignment, homework, or classroom assessment.", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "dueDate": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment is due." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "gradebookEntryTitle", + "dateAssigned", + "sectionReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradebookEntry", + "description": "This entity represents an assignment, homework, or classroom assessment to be recorded in a gradebook.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "gradebookEntryTitle": { + "type": "string", + "description": "The name or title of the activity to be recorded in the GradebookEntry.", + "minLength": 1, + "maxLength": 60 + }, + "gradebookEntryTypeDescriptor": { + "type": "string", + "description": "The type of the GradebookEntry; for example, homework, assignment, quiz, unit test, oral presentation, etc." + }, + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "description": { + "type": "string", + "description": "A description of the assignment, homework, or classroom assessment.", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "dueDate": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment is due." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "gradebookEntryTitle", + "dateAssigned", + "sectionReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradebookEntry", + "description": "This entity represents an assignment, homework, or classroom assessment to be recorded in a gradebook.", + "type": "object", + "properties": { + "gradebookEntryTitle": { + "type": "string", + "description": "The name or title of the activity to be recorded in the GradebookEntry.", + "minLength": 1, + "maxLength": 60 + }, + "gradebookEntryTypeDescriptor": { + "type": "string", + "description": "The type of the GradebookEntry; for example, homework, assignment, quiz, unit test, oral presentation, etc." + }, + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "description": { + "type": "string", + "description": "A description of the assignment, homework, or classroom assessment.", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "dueDate": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment is due." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.gradingPeriodReference.schoolId", + "targetJsonPath": "$.sectionReference.schoolId" + }, + { + "sourceJsonPath": "$.gradingPeriodReference.schoolYear", + "targetJsonPath": "$.sectionReference.schoolYear" + } + ], + "identityFullnames": [ + "GradebookEntryTitle", + "DateAssigned", + "Section" + ], + "documentPathsMapping": { + "GradebookEntryTitle": [ + "$.gradebookEntryTitle" + ], + "GradebookEntryType": [ + "$.gradebookEntryTypeDescriptor" + ], + "DateAssigned": [ + "$.dateAssigned" + ], + "Description": [ + "$.description" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "LearningObjective": [ + "$.learningObjectives[*].learningObjectiveReference.learningObjectiveId", + "$.learningObjectives[*].learningObjectiveReference.namespace" + ], + "Section": [ + "$.sectionReference.localCourseCode", + "$.sectionReference.schoolId", + "$.sectionReference.schoolYear", + "$.sectionReference.sectionIdentifier", + "$.sectionReference.sessionName" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ], + "DueDate": [ + "$.dueDate" + ] + } + }, + "gradingPeriods": { + "resourceName": "GradingPeriod", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradingPeriod", + "description": "This entity represents the time span for which grades are reported.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the GradingPeriod." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the last day of the GradingPeriod." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "Total days available for educational instruction during the GradingPeriod.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "gradingPeriodDescriptor", + "periodSequence", + "schoolYearTypeReference", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradingPeriod", + "description": "This entity represents the time span for which grades are reported.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the GradingPeriod." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the last day of the GradingPeriod." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "Total days available for educational instruction during the GradingPeriod.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "gradingPeriodDescriptor", + "periodSequence", + "schoolYearTypeReference", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradingPeriod", + "description": "This entity represents the time span for which grades are reported.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the GradingPeriod." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the last day of the GradingPeriod." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "Total days available for educational instruction during the GradingPeriod.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "GradingPeriod", + "PeriodSequence", + "SchoolYear" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "GradingPeriod": [ + "$.gradingPeriodDescriptor" + ], + "PeriodSequence": [ + "$.periodSequence" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "TotalInstructionalDays": [ + "$.totalInstructionalDays" + ] + } + }, + "graduationPlans": { + "resourceName": "GraduationPlan", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GraduationPlan", + "description": "This entity is a plan outlining the required credits, credits by subject, credits by course, and other criteria required for graduation. A graduation plan may be one or more standard plans defined by an education organization and/or individual plans for some or all students.", + "type": "object", + "properties": { + "graduationPlanTypeDescriptor": { + "type": "string", + "description": "The type of academic plan the student is following for graduation: for example, Minimum, Recommended, Distinguished, or Standard." + }, + "individualPlan": { + "type": "boolean", + "description": "An indicator of whether the GraduationPlan is tailored for an individual." + }, + "totalRequiredCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "creditsBySubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the graduation requirement." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCourses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseSetName": { + "type": "string", + "description": "Identifying name given to a collection of courses.", + "minLength": 1, + "maxLength": 120 + }, + "courses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + } + }, + "additionalProperties": false, + "required": [ + "courseReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "The grade level when the student is planned to take the course." + } + }, + "additionalProperties": false, + "required": [ + "courseSetName", + "courses", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCreditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "A categorization for the course transcript credits awarded in the course transcript." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "graduationSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "requiredAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevel": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "graduationPlanTypeDescriptor", + "totalRequiredCredits", + "educationOrganizationReference", + "graduationSchoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GraduationPlan", + "description": "This entity is a plan outlining the required credits, credits by subject, credits by course, and other criteria required for graduation. A graduation plan may be one or more standard plans defined by an education organization and/or individual plans for some or all students.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "graduationPlanTypeDescriptor": { + "type": "string", + "description": "The type of academic plan the student is following for graduation: for example, Minimum, Recommended, Distinguished, or Standard." + }, + "individualPlan": { + "type": "boolean", + "description": "An indicator of whether the GraduationPlan is tailored for an individual." + }, + "totalRequiredCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "creditsBySubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the graduation requirement." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCourses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseSetName": { + "type": "string", + "description": "Identifying name given to a collection of courses.", + "minLength": 1, + "maxLength": 120 + }, + "courses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + } + }, + "additionalProperties": false, + "required": [ + "courseReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "The grade level when the student is planned to take the course." + } + }, + "additionalProperties": false, + "required": [ + "courseSetName", + "courses", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCreditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "A categorization for the course transcript credits awarded in the course transcript." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "graduationSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "requiredAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevel": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "graduationPlanTypeDescriptor", + "totalRequiredCredits", + "educationOrganizationReference", + "graduationSchoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GraduationPlan", + "description": "This entity is a plan outlining the required credits, credits by subject, credits by course, and other criteria required for graduation. A graduation plan may be one or more standard plans defined by an education organization and/or individual plans for some or all students.", + "type": "object", + "properties": { + "graduationPlanTypeDescriptor": { + "type": "string", + "description": "The type of academic plan the student is following for graduation: for example, Minimum, Recommended, Distinguished, or Standard." + }, + "individualPlan": { + "type": "boolean", + "description": "An indicator of whether the GraduationPlan is tailored for an individual." + }, + "totalRequiredCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "creditsBySubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the graduation requirement." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCourses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseSetName": { + "type": "string", + "description": "Identifying name given to a collection of courses.", + "minLength": 1, + "maxLength": 120 + }, + "courses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + } + }, + "additionalProperties": false, + "required": [ + "courseReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "The grade level when the student is planned to take the course." + } + }, + "additionalProperties": false, + "required": [ + "courseSetName", + "courses", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCreditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "A categorization for the course transcript credits awarded in the course transcript." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "graduationSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "requiredAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevel": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "GraduationPlanType", + "EducationOrganization", + "GraduationSchoolYear" + ], + "documentPathsMapping": { + "GraduationPlanType": [ + "$.graduationPlanTypeDescriptor" + ], + "IndividualPlan": [ + "$.individualPlan" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "GraduationSchoolYear": [ + "$.graduationSchoolYearTypeReference.schoolYear" + ] + } + }, + "interventions": { + "resourceName": "Intervention", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Intervention", + "description": "An implementation of an instructional approach focusing on the specific techniques and materials used to teach a given subject.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionPrescriptions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the intervention implementation." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the intervention implementation." + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that may be assigned for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that may be assigned for the intervention." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "beginDate", + "educationOrganizationReference", + "interventionIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Intervention", + "description": "An implementation of an instructional approach focusing on the specific techniques and materials used to teach a given subject.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionPrescriptions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the intervention implementation." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the intervention implementation." + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that may be assigned for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that may be assigned for the intervention." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "beginDate", + "educationOrganizationReference", + "interventionIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Intervention", + "description": "An implementation of an instructional approach focusing on the specific techniques and materials used to teach a given subject.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionPrescriptions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the intervention implementation." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the intervention implementation." + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that may be assigned for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that may be assigned for the intervention." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "InterventionIdentificationCode" + ], + "documentPathsMapping": { + "InterventionClass": [ + "$.interventionClassDescriptor" + ], + "Diagnosis": [ + "$.diagnoses[*].diagnosisDescriptor" + ], + "PopulationServed": [ + "$.populationServeds[*].populationServedDescriptor" + ], + "AppropriateSex": [ + "$.appropriateSexes[*].sexDescriptor" + ], + "AppropriateGradeLevel": [ + "$.appropriateGradeLevels[*].gradeLevelDescriptor" + ], + "DeliveryMethod": [ + "$.deliveryMethodDescriptor" + ], + "InterventionPrescription": [ + "$.interventionPrescriptions[*].interventionPrescriptionReference.educationOrganizationId", + "$.interventionPrescriptions[*].interventionPrescriptionReference.interventionPrescriptionIdentificationCode" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "Staff": [ + "$.staffs[*].staffReference.staffUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "InterventionIdentificationCode": [ + "$.interventionIdentificationCode" + ], + "MinDosage": [ + "$.minDosage" + ], + "MaxDosage": [ + "$.maxDosage" + ] + } + }, + "interventionPrescriptions": { + "resourceName": "InterventionPrescription", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionPrescription", + "description": "This entity represents a formal prescription of an instructional approach focusing on the specific techniques and materials used to teach a given subject. This can be prescribed by academic research, an interventions vendor, or another entity.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that is recommended for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that is recommended for the intervention." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "educationOrganizationReference", + "interventionPrescriptionIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionPrescription", + "description": "This entity represents a formal prescription of an instructional approach focusing on the specific techniques and materials used to teach a given subject. This can be prescribed by academic research, an interventions vendor, or another entity.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that is recommended for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that is recommended for the intervention." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "educationOrganizationReference", + "interventionPrescriptionIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionPrescription", + "description": "This entity represents a formal prescription of an instructional approach focusing on the specific techniques and materials used to teach a given subject. This can be prescribed by academic research, an interventions vendor, or another entity.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that is recommended for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that is recommended for the intervention." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "InterventionPrescriptionIdentificationCode" + ], + "documentPathsMapping": { + "InterventionClass": [ + "$.interventionClassDescriptor" + ], + "Diagnosis": [ + "$.diagnoses[*].diagnosisDescriptor" + ], + "PopulationServed": [ + "$.populationServeds[*].populationServedDescriptor" + ], + "AppropriateSex": [ + "$.appropriateSexes[*].sexDescriptor" + ], + "AppropriateGradeLevel": [ + "$.appropriateGradeLevels[*].gradeLevelDescriptor" + ], + "DeliveryMethod": [ + "$.deliveryMethodDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "InterventionPrescriptionIdentificationCode": [ + "$.interventionPrescriptionIdentificationCode" + ], + "MinDosage": [ + "$.minDosage" + ], + "MaxDosage": [ + "$.maxDosage" + ] + } + }, + "interventionStudies": { + "resourceName": "InterventionStudy", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionStudy", + "description": "An experimental or quasi-experimental study of an intervention technique.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + }, + "interventionEffectivenesses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "Targeted purpose of the intervention (e.g., attendance issue, dropout risk) for which the effectiveness is measured." + }, + "populationServedDescriptor": { + "type": "string", + "description": "Population for which effectiveness is measured." + }, + "gradeLevelDescriptor": { + "type": "string", + "description": "Grade level for which effectiveness is measured." + }, + "improvementIndex": { + "type": "integer", + "description": "Along a percentile distribution of students, the improvement index represents the change in an average student's percentile rank that is considered to be due to the intervention." + }, + "interventionEffectivenessRatingDescriptor": { + "type": "string", + "description": "An intervention demonstrates effectiveness if the research has shown that the program caused an improvement in outcomes. Values: positive effects, potentially positive effects, mixed effects, potentially negative effects, negative effects, and no discernible effects." + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor", + "populationServedDescriptor", + "gradeLevelDescriptor", + "interventionEffectivenessRatingDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "participants": { + "type": "integer", + "description": "The number of participants observed in the study." + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateAbbreviations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stateAbbreviationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "stateAbbreviationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionStudyIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention study.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference", + "participants", + "deliveryMethodDescriptor", + "interventionClassDescriptor", + "educationOrganizationReference", + "interventionStudyIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionStudy", + "description": "An experimental or quasi-experimental study of an intervention technique.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + }, + "interventionEffectivenesses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "Targeted purpose of the intervention (e.g., attendance issue, dropout risk) for which the effectiveness is measured." + }, + "populationServedDescriptor": { + "type": "string", + "description": "Population for which effectiveness is measured." + }, + "gradeLevelDescriptor": { + "type": "string", + "description": "Grade level for which effectiveness is measured." + }, + "improvementIndex": { + "type": "integer", + "description": "Along a percentile distribution of students, the improvement index represents the change in an average student's percentile rank that is considered to be due to the intervention." + }, + "interventionEffectivenessRatingDescriptor": { + "type": "string", + "description": "An intervention demonstrates effectiveness if the research has shown that the program caused an improvement in outcomes. Values: positive effects, potentially positive effects, mixed effects, potentially negative effects, negative effects, and no discernible effects." + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor", + "populationServedDescriptor", + "gradeLevelDescriptor", + "interventionEffectivenessRatingDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "participants": { + "type": "integer", + "description": "The number of participants observed in the study." + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateAbbreviations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stateAbbreviationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "stateAbbreviationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionStudyIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention study.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "interventionPrescriptionReference", + "participants", + "deliveryMethodDescriptor", + "interventionClassDescriptor", + "educationOrganizationReference", + "interventionStudyIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionStudy", + "description": "An experimental or quasi-experimental study of an intervention technique.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the EducationContent.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + }, + "interventionEffectivenesses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "Targeted purpose of the intervention (e.g., attendance issue, dropout risk) for which the effectiveness is measured." + }, + "populationServedDescriptor": { + "type": "string", + "description": "Population for which effectiveness is measured." + }, + "gradeLevelDescriptor": { + "type": "string", + "description": "Grade level for which effectiveness is measured." + }, + "improvementIndex": { + "type": "integer", + "description": "Along a percentile distribution of students, the improvement index represents the change in an average student's percentile rank that is considered to be due to the intervention." + }, + "interventionEffectivenessRatingDescriptor": { + "type": "string", + "description": "An intervention demonstrates effectiveness if the research has shown that the program caused an improvement in outcomes. Values: positive effects, potentially positive effects, mixed effects, potentially negative effects, negative effects, and no discernible effects." + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor", + "populationServedDescriptor", + "gradeLevelDescriptor", + "interventionEffectivenessRatingDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "participants": { + "type": "integer", + "description": "The number of participants observed in the study." + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateAbbreviations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stateAbbreviationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "stateAbbreviationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionStudyIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention study.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "InterventionStudyIdentificationCode" + ], + "documentPathsMapping": { + "InterventionPrescription": [ + "$.interventionPrescriptionReference.educationOrganizationId", + "$.interventionPrescriptionReference.interventionPrescriptionIdentificationCode" + ], + "Participants": [ + "$.participants" + ], + "DeliveryMethod": [ + "$.deliveryMethodDescriptor" + ], + "InterventionClass": [ + "$.interventionClassDescriptor" + ], + "AppropriateGradeLevel": [ + "$.appropriateGradeLevels[*].gradeLevelDescriptor" + ], + "PopulationServed": [ + "$.populationServeds[*].populationServedDescriptor" + ], + "AppropriateSex": [ + "$.appropriateSexes[*].sexDescriptor" + ], + "StateAbbreviation": [ + "$.stateAbbreviations[*].stateAbbreviationDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "InterventionStudyIdentificationCode": [ + "$.interventionStudyIdentificationCode" + ] + } + }, + "learningObjectives": { + "resourceName": "LearningObjective", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningObjective", + "description": "This entity represents identified learning objectives for courses in specific grades.", + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "objective": { + "type": "string", + "description": "The designated title of the LearningObjective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the LearningObjective.", + "minLength": 1, + "maxLength": 1024 + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for the LearningObjective.", + "minLength": 1, + "maxLength": 35 + }, + "successCriteria": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 150 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLearningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "objective", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningObjective", + "description": "This entity represents identified learning objectives for courses in specific grades.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "objective": { + "type": "string", + "description": "The designated title of the LearningObjective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the LearningObjective.", + "minLength": 1, + "maxLength": 1024 + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for the LearningObjective.", + "minLength": 1, + "maxLength": 35 + }, + "successCriteria": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 150 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLearningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "learningObjectiveId", + "objective", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningObjective", + "description": "This entity represents identified learning objectives for courses in specific grades.", + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "objective": { + "type": "string", + "description": "The designated title of the LearningObjective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the LearningObjective.", + "minLength": 1, + "maxLength": 1024 + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for the LearningObjective.", + "minLength": 1, + "maxLength": 35 + }, + "successCriteria": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 150 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLearningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LearningObjectiveId", + "Namespace" + ], + "documentPathsMapping": { + "LearningObjectiveId": [ + "$.learningObjectiveId" + ], + "Objective": [ + "$.objective" + ], + "Description": [ + "$.description" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "ObjectiveGradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "Nomenclature": [ + "$.nomenclature" + ], + "SuccessCriteria": [ + "$.successCriteria" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "ParentLearningObjective": [ + "$.parentLearningObjectiveReference.learningObjectiveId", + "$.parentLearningObjectiveReference.namespace" + ], + "Namespace": [ + "$.namespace" + ] + } + }, + "learningStandards": { + "resourceName": "LearningStandard", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningStandard", + "description": "A statement that describes a specific competency or academic standard.", + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a Learning Standard.", + "minLength": 1, + "maxLength": 60 + }, + "contentStandardName": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 65 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "contentStandardName" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "description": { + "type": "string", + "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\".", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandardItemCode": { + "type": "string", + "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the statement using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "courseTitle": { + "type": "string", + "description": "The official Course Title with which this learning standard is associated.", + "minLength": 1, + "maxLength": 60 + }, + "successCriteria": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 150 + }, + "prerequisiteLearningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "prerequisiteLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "prerequisiteLearningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "namespace": { + "type": "string", + "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.", + "minLength": 5, + "maxLength": 255 + }, + "learningStandardCategoryDescriptor": { + "type": "string", + "description": "An additional classification of the type of a specific learning standard." + }, + "learningStandardScopeDescriptor": { + "type": "string", + "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId", + "description", + "contentStandard", + "gradeLevels", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningStandard", + "description": "A statement that describes a specific competency or academic standard.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a Learning Standard.", + "minLength": 1, + "maxLength": 60 + }, + "contentStandardName": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 65 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "contentStandardName" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "description": { + "type": "string", + "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\".", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandardItemCode": { + "type": "string", + "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the statement using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "courseTitle": { + "type": "string", + "description": "The official Course Title with which this learning standard is associated.", + "minLength": 1, + "maxLength": 60 + }, + "successCriteria": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 150 + }, + "prerequisiteLearningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "prerequisiteLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "prerequisiteLearningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "namespace": { + "type": "string", + "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.", + "minLength": 5, + "maxLength": 255 + }, + "learningStandardCategoryDescriptor": { + "type": "string", + "description": "An additional classification of the type of a specific learning standard." + }, + "learningStandardScopeDescriptor": { + "type": "string", + "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "learningStandardId", + "description", + "contentStandard", + "gradeLevels", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningStandard", + "description": "A statement that describes a specific competency or academic standard.", + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a Learning Standard.", + "minLength": 1, + "maxLength": 60 + }, + "contentStandardName": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 65 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "contentStandardName" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "description": { + "type": "string", + "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\".", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandardItemCode": { + "type": "string", + "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the statement using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "courseTitle": { + "type": "string", + "description": "The official Course Title with which this learning standard is associated.", + "minLength": 1, + "maxLength": 60 + }, + "successCriteria": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 150 + }, + "prerequisiteLearningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "prerequisiteLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "prerequisiteLearningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "namespace": { + "type": "string", + "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.", + "minLength": 5, + "maxLength": 255 + }, + "learningStandardCategoryDescriptor": { + "type": "string", + "description": "An additional classification of the type of a specific learning standard." + }, + "learningStandardScopeDescriptor": { + "type": "string", + "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LearningStandardId" + ], + "documentPathsMapping": { + "LearningStandardId": [ + "$.learningStandardId" + ], + "Description": [ + "$.description" + ], + "LearningStandardItemCode": [ + "$.learningStandardItemCode" + ], + "URI": [ + "$.uri" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "CourseTitle": [ + "$.courseTitle" + ], + "SuccessCriteria": [ + "$.successCriteria" + ], + "PrerequisiteLearningStandard": [ + "$.prerequisiteLearningStandards[*].prerequisiteLearningStandardReference.learningStandardId" + ], + "ParentLearningStandard": [ + "$.parentLearningStandardReference.learningStandardId" + ], + "Namespace": [ + "$.namespace" + ], + "LearningStandardCategory": [ + "$.learningStandardCategoryDescriptor" + ], + "LearningStandardScope": [ + "$.learningStandardScopeDescriptor" + ] + } + }, + "locations": { + "resourceName": "Location", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Location", + "description": "This entity represents the physical space where students gather for a particular class/section. The Location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maximumNumberOfSeats": { + "type": "integer", + "description": "The most number of seats the class can maintain." + }, + "optimalNumberOfSeats": { + "type": "integer", + "description": "The number of seats that is most favorable to the class." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "classroomIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Location", + "description": "This entity represents the physical space where students gather for a particular class/section. The Location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maximumNumberOfSeats": { + "type": "integer", + "description": "The most number of seats the class can maintain." + }, + "optimalNumberOfSeats": { + "type": "integer", + "description": "The number of seats that is most favorable to the class." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "classroomIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Location", + "description": "This entity represents the physical space where students gather for a particular class/section. The Location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maximumNumberOfSeats": { + "type": "integer", + "description": "The most number of seats the class can maintain." + }, + "optimalNumberOfSeats": { + "type": "integer", + "description": "The number of seats that is most favorable to the class." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "ClassroomIdentificationCode" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "ClassroomIdentificationCode": [ + "$.classroomIdentificationCode" + ], + "MaximumNumberOfSeats": [ + "$.maximumNumberOfSeats" + ], + "OptimalNumberOfSeats": [ + "$.optimalNumberOfSeats" + ] + } + }, + "objectiveAssessments": { + "resourceName": "ObjectiveAssessment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectiveAssessment", + "description": "This entity represents subtests that assess specific learning objectives.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "percentOfAssessment": { + "type": "number", + "description": "The percentage of the Assessment that tests this objective." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for this level of ObjectiveAssessment.", + "minLength": 1, + "maxLength": 35 + }, + "description": { + "type": "string", + "description": "The description of the ObjectiveAssessment (e.g., vocabulary, measurement, or geometry).", + "minLength": 1, + "maxLength": 1024 + }, + "assessmentItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentObjectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The subject area of the objective assessment." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectiveAssessment", + "description": "This entity represents subtests that assess specific learning objectives.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "percentOfAssessment": { + "type": "number", + "description": "The percentage of the Assessment that tests this objective." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for this level of ObjectiveAssessment.", + "minLength": 1, + "maxLength": 35 + }, + "description": { + "type": "string", + "description": "The description of the ObjectiveAssessment (e.g., vocabulary, measurement, or geometry).", + "minLength": 1, + "maxLength": 1024 + }, + "assessmentItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentObjectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The subject area of the objective assessment." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectiveAssessment", + "description": "This entity represents subtests that assess specific learning objectives.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "percentOfAssessment": { + "type": "number", + "description": "The percentage of the Assessment that tests this objective." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for this level of ObjectiveAssessment.", + "minLength": 1, + "maxLength": 35 + }, + "description": { + "type": "string", + "description": "The description of the ObjectiveAssessment (e.g., vocabulary, measurement, or geometry).", + "minLength": 1, + "maxLength": 1024 + }, + "assessmentItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentObjectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The subject area of the objective assessment." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.assessmentItems[*].assessmentItemReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.assessmentItems[*].assessmentItemReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + }, + { + "sourceJsonPath": "$.parentObjectiveAssessmentReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.parentObjectiveAssessmentReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + } + ], + "identityFullnames": [ + "IdentificationCode", + "Assessment" + ], + "documentPathsMapping": { + "IdentificationCode": [ + "$.identificationCode" + ], + "MaxRawScore": [ + "$.maxRawScore" + ], + "PercentOfAssessment": [ + "$.percentOfAssessment" + ], + "Nomenclature": [ + "$.nomenclature" + ], + "Description": [ + "$.description" + ], + "AssessmentItem": [ + "$.assessmentItems[*].assessmentItemReference.assessmentIdentifier", + "$.assessmentItems[*].assessmentItemReference.identificationCode", + "$.assessmentItems[*].assessmentItemReference.namespace" + ], + "LearningObjective": [ + "$.learningObjectives[*].learningObjectiveReference.learningObjectiveId", + "$.learningObjectives[*].learningObjectiveReference.namespace" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "ParentObjectiveAssessment": [ + "$.parentObjectiveAssessmentReference.assessmentIdentifier", + "$.parentObjectiveAssessmentReference.identificationCode", + "$.parentObjectiveAssessmentReference.namespace" + ], + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ] + } + }, + "openStaffPositions": { + "resourceName": "OpenStaffPosition", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OpenStaffPosition", + "description": "This entity represents an open staff position that the education organization is seeking to fill.", + "type": "object", + "properties": { + "employmentStatusDescriptor": { + "type": "string", + "description": "Reflects the type of employment or contract desired for the position; for example: Probationary Contractual Substitute/temporary Tenured or permanent Volunteer/no contract ..." + }, + "staffClassificationDescriptor": { + "type": "string", + "description": "The titles of employment, official status, or rank of education staff." + }, + "positionTitle": { + "type": "string", + "description": "The descriptive name of an individual's position.", + "minLength": 1, + "maxLength": 100 + }, + "requisitionNumber": { + "type": "string", + "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", + "minLength": 1, + "maxLength": 20 + }, + "programAssignmentDescriptor": { + "type": "string", + "description": "The name of the program for which the OpenStaffPosition will be assigned; for example: Regular education Title I-Academic Title I-Non-Academic Special Education' Bilingual/English as a Second Language." + }, + "instructionalGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "datePosted": { + "type": "string", + "format": "date", + "description": "Date the OpenStaffPosition was posted." + }, + "datePostingRemoved": { + "type": "string", + "format": "date", + "description": "The date the posting was removed or filled." + }, + "postingResultDescriptor": { + "type": "string", + "description": "Indication of whether the OpenStaffPosition was filled or retired without filling." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "employmentStatusDescriptor", + "staffClassificationDescriptor", + "requisitionNumber", + "datePosted", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OpenStaffPosition", + "description": "This entity represents an open staff position that the education organization is seeking to fill.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "employmentStatusDescriptor": { + "type": "string", + "description": "Reflects the type of employment or contract desired for the position; for example: Probationary Contractual Substitute/temporary Tenured or permanent Volunteer/no contract ..." + }, + "staffClassificationDescriptor": { + "type": "string", + "description": "The titles of employment, official status, or rank of education staff." + }, + "positionTitle": { + "type": "string", + "description": "The descriptive name of an individual's position.", + "minLength": 1, + "maxLength": 100 + }, + "requisitionNumber": { + "type": "string", + "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", + "minLength": 1, + "maxLength": 20 + }, + "programAssignmentDescriptor": { + "type": "string", + "description": "The name of the program for which the OpenStaffPosition will be assigned; for example: Regular education Title I-Academic Title I-Non-Academic Special Education' Bilingual/English as a Second Language." + }, + "instructionalGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "datePosted": { + "type": "string", + "format": "date", + "description": "Date the OpenStaffPosition was posted." + }, + "datePostingRemoved": { + "type": "string", + "format": "date", + "description": "The date the posting was removed or filled." + }, + "postingResultDescriptor": { + "type": "string", + "description": "Indication of whether the OpenStaffPosition was filled or retired without filling." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "employmentStatusDescriptor", + "staffClassificationDescriptor", + "requisitionNumber", + "datePosted", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OpenStaffPosition", + "description": "This entity represents an open staff position that the education organization is seeking to fill.", + "type": "object", + "properties": { + "employmentStatusDescriptor": { + "type": "string", + "description": "Reflects the type of employment or contract desired for the position; for example: Probationary Contractual Substitute/temporary Tenured or permanent Volunteer/no contract ..." + }, + "staffClassificationDescriptor": { + "type": "string", + "description": "The titles of employment, official status, or rank of education staff." + }, + "positionTitle": { + "type": "string", + "description": "The descriptive name of an individual's position.", + "minLength": 1, + "maxLength": 100 + }, + "requisitionNumber": { + "type": "string", + "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", + "minLength": 1, + "maxLength": 20 + }, + "programAssignmentDescriptor": { + "type": "string", + "description": "The name of the program for which the OpenStaffPosition will be assigned; for example: Regular education Title I-Academic Title I-Non-Academic Special Education' Bilingual/English as a Second Language." + }, + "instructionalGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "datePosted": { + "type": "string", + "format": "date", + "description": "Date the OpenStaffPosition was posted." + }, + "datePostingRemoved": { + "type": "string", + "format": "date", + "description": "The date the posting was removed or filled." + }, + "postingResultDescriptor": { + "type": "string", + "description": "Indication of whether the OpenStaffPosition was filled or retired without filling." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "RequisitionNumber", + "EducationOrganization" + ], + "documentPathsMapping": { + "EmploymentStatus": [ + "$.employmentStatusDescriptor" + ], + "StaffClassification": [ + "$.staffClassificationDescriptor" + ], + "PositionTitle": [ + "$.positionTitle" + ], + "RequisitionNumber": [ + "$.requisitionNumber" + ], + "ProgramAssignment": [ + "$.programAssignmentDescriptor" + ], + "InstructionalGradeLevel": [ + "$.instructionalGradeLevels[*].gradeLevelDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "DatePosted": [ + "$.datePosted" + ], + "DatePostingRemoved": [ + "$.datePostingRemoved" + ], + "PostingResult": [ + "$.postingResultDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ] + } + }, + "parents": { + "resourceName": "Parent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Parent", + "description": "This entity represents a parent or guardian of a student, such as mother, father, or caretaker.", + "type": "object", + "properties": { + "parentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a parent.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "parentUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Parent", + "description": "This entity represents a parent or guardian of a student, such as mother, father, or caretaker.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "parentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a parent.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "parentUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Parent", + "description": "This entity represents a parent or guardian of a student, such as mother, father, or caretaker.", + "type": "object", + "properties": { + "parentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a parent.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "ParentUniqueId" + ], + "documentPathsMapping": { + "ParentUniqueId": [ + "$.parentUniqueId" + ], + "Sex": [ + "$.sexDescriptor" + ], + "LoginId": [ + "$.loginId" + ], + "Person": [ + "$.personReference.personId", + "$.personReference.sourceSystemDescriptor" + ], + "HighestCompletedLevelOfEducation": [ + "$.highestCompletedLevelOfEducationDescriptor" + ] + } + }, + "payrolls": { + "resourceName": "Payroll", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Payroll", + "description": "This financial entity represents the sum of the financial transactions to date for employee compensation. An \"employee\" who performs services under the direction of the employing institution or agency, is compensated for such services by the employer and is eligible for employee benefits and wage or salary tax withholdings.", + "type": "object", + "properties": { + "amountToDate": { + "type": "number", + "description": "Current balance (amount paid to employee) for account for the fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported payroll element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "amountToDate", + "asOfDate", + "accountReference", + "staffReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Payroll", + "description": "This financial entity represents the sum of the financial transactions to date for employee compensation. An \"employee\" who performs services under the direction of the employing institution or agency, is compensated for such services by the employer and is eligible for employee benefits and wage or salary tax withholdings.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "amountToDate": { + "type": "number", + "description": "Current balance (amount paid to employee) for account for the fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported payroll element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "amountToDate", + "asOfDate", + "accountReference", + "staffReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Payroll", + "description": "This financial entity represents the sum of the financial transactions to date for employee compensation. An \"employee\" who performs services under the direction of the employing institution or agency, is compensated for such services by the employer and is eligible for employee benefits and wage or salary tax withholdings.", + "type": "object", + "properties": { + "amountToDate": { + "type": "number", + "description": "Current balance (amount paid to employee) for account for the fiscal year." + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported payroll element." + }, + "accountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "The alphanumeric string that identifies the account.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The financial accounting year." + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "AsOfDate", + "Account", + "Staff" + ], + "documentPathsMapping": { + "AmountToDate": [ + "$.amountToDate" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Account": [ + "$.accountReference.accountIdentifier", + "$.accountReference.educationOrganizationId", + "$.accountReference.fiscalYear" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "people": { + "resourceName": "Person", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Person", + "description": "This entity represents a human being.", + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Person", + "description": "This entity represents a human being.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "personId", + "sourceSystemDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Person", + "description": "This entity represents a human being.", + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "PersonId", + "SourceSystem" + ], + "documentPathsMapping": { + "PersonId": [ + "$.personId" + ], + "SourceSystem": [ + "$.sourceSystemDescriptor" + ] + } + }, + "postSecondaryEvents": { + "resourceName": "PostSecondaryEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryEvent", + "description": "This entity captures significant postsecondary events during a student's high school tenure (e.g., FAFSA application or college application, acceptance, and enrollment) or during a student's enrollment at a post-secondary institution.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the event occurred or was recorded." + }, + "postSecondaryEventCategoryDescriptor": { + "type": "string", + "description": "The PostSecondaryEvent that is logged (e.g., FAFSA application, college application, college acceptance)." + }, + "postSecondaryInstitutionReference": { + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryEvent", + "description": "This entity captures significant postsecondary events during a student's high school tenure (e.g., FAFSA application or college application, acceptance, and enrollment) or during a student's enrollment at a post-secondary institution.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the event occurred or was recorded." + }, + "postSecondaryEventCategoryDescriptor": { + "type": "string", + "description": "The PostSecondaryEvent that is logged (e.g., FAFSA application, college application, college acceptance)." + }, + "postSecondaryInstitutionReference": { + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryEvent", + "description": "This entity captures significant postsecondary events during a student's high school tenure (e.g., FAFSA application or college application, acceptance, and enrollment) or during a student's enrollment at a post-secondary institution.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the event occurred or was recorded." + }, + "postSecondaryEventCategoryDescriptor": { + "type": "string", + "description": "The PostSecondaryEvent that is logged (e.g., FAFSA application, college application, college acceptance)." + }, + "postSecondaryInstitutionReference": { + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EventDate", + "PostSecondaryEventCategory", + "Student" + ], + "documentPathsMapping": { + "EventDate": [ + "$.eventDate" + ], + "PostSecondaryEventCategory": [ + "$.postSecondaryEventCategoryDescriptor" + ], + "PostSecondaryInstitution": [ + "$.postSecondaryInstitutionReference.postSecondaryInstitutionId" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ] + } + }, + "programs": { + "resourceName": "Program", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Program", + "description": "This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services, or benefits through federal, state, or local agencies. Programs may also include organized extracurricular activities for students.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sponsors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programSponsorDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programSponsorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationReference", + "programName", + "programTypeDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Program", + "description": "This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services, or benefits through federal, state, or local agencies. Programs may also include organized extracurricular activities for students.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sponsors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programSponsorDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programSponsorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationOrganizationReference", + "programName", + "programTypeDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Program", + "description": "This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services, or benefits through federal, state, or local agencies. Programs may also include organized extracurricular activities for students.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sponsors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programSponsorDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programSponsorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "ProgramName", + "ProgramType" + ], + "documentPathsMapping": { + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ProgramId": [ + "$.programId" + ], + "ProgramName": [ + "$.programName" + ], + "ProgramType": [ + "$.programTypeDescriptor" + ], + "ProgramCharacteristic": [ + "$.characteristics[*].programCharacteristicDescriptor" + ], + "ProgramSponsor": [ + "$.sponsors[*].programSponsorDescriptor" + ], + "Service": [ + "$.services[*].serviceDescriptor" + ], + "LearningObjective": [ + "$.learningObjectives[*].learningObjectiveReference.learningObjectiveId", + "$.learningObjectives[*].learningObjectiveReference.namespace" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ] + } + }, + "reportCards": { + "resourceName": "ReportCard", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ReportCard", + "description": "This educational entity represents the collection of student grades for courses taken during a grading period.", + "type": "object", + "properties": { + "grades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeReference": { + "type": "object", + "properties": { + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., Exam, Final, Grading Period)." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "beginDate", + "localCourseCode", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentCompetencyObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentCompetencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentCompetencyObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentLearningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentLearningObjectiveReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "learningObjectiveId", + "namespace", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentLearningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "gpaGivenGradingPeriod": { + "type": "number", + "description": "A measure of average performance in all courses taken by an individual for the current grading period." + }, + "gpaCumulative": { + "type": "number", + "description": "A measure of cumulative average performance in all courses taken by an individual from the beginning of the school year through the current grading period." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "numberOfDaysAbsent": { + "type": "number", + "description": "The number of days an individual is absent when school is in session during a given reporting period." + }, + "numberOfDaysInAttendance": { + "type": "number", + "description": "The number of days an individual is present when school is in session during a given reporting period." + }, + "numberOfDaysTardy": { + "type": "integer", + "description": "The number of days an individual is tardy during a given reporting period.", + "minimum": 0 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "educationOrganizationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ReportCard", + "description": "This educational entity represents the collection of student grades for courses taken during a grading period.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "grades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeReference": { + "type": "object", + "properties": { + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., Exam, Final, Grading Period)." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "beginDate", + "localCourseCode", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentCompetencyObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentCompetencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentCompetencyObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentLearningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentLearningObjectiveReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "learningObjectiveId", + "namespace", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentLearningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "gpaGivenGradingPeriod": { + "type": "number", + "description": "A measure of average performance in all courses taken by an individual for the current grading period." + }, + "gpaCumulative": { + "type": "number", + "description": "A measure of cumulative average performance in all courses taken by an individual from the beginning of the school year through the current grading period." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "numberOfDaysAbsent": { + "type": "number", + "description": "The number of days an individual is absent when school is in session during a given reporting period." + }, + "numberOfDaysInAttendance": { + "type": "number", + "description": "The number of days an individual is present when school is in session during a given reporting period." + }, + "numberOfDaysTardy": { + "type": "integer", + "description": "The number of days an individual is tardy during a given reporting period.", + "minimum": 0 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "educationOrganizationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ReportCard", + "description": "This educational entity represents the collection of student grades for courses taken during a grading period.", + "type": "object", + "properties": { + "grades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeReference": { + "type": "object", + "properties": { + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., Exam, Final, Grading Period)." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "beginDate", + "localCourseCode", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentCompetencyObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentCompetencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentCompetencyObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentLearningObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentLearningObjectiveReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "learningObjectiveId", + "namespace", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentLearningObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "gpaGivenGradingPeriod": { + "type": "number", + "description": "A measure of average performance in all courses taken by an individual for the current grading period." + }, + "gpaCumulative": { + "type": "number", + "description": "A measure of cumulative average performance in all courses taken by an individual from the beginning of the school year through the current grading period." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "numberOfDaysAbsent": { + "type": "number", + "description": "The number of days an individual is absent when school is in session during a given reporting period." + }, + "numberOfDaysInAttendance": { + "type": "number", + "description": "The number of days an individual is present when school is in session during a given reporting period." + }, + "numberOfDaysTardy": { + "type": "integer", + "description": "The number of days an individual is tardy during a given reporting period.", + "minimum": 0 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.grades[*].gradeReference.gradingPeriodDescriptor", + "targetJsonPath": "$.gradingPeriodReference.gradingPeriodDescriptor" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.periodSequence", + "targetJsonPath": "$.gradingPeriodReference.periodSequence" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.schoolId", + "targetJsonPath": "$.gradingPeriodReference.schoolId" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.schoolYear", + "targetJsonPath": "$.gradingPeriodReference.schoolYear" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.gradingPeriodDescriptor", + "targetJsonPath": "$.gradingPeriodReference.gradingPeriodDescriptor" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.periodSequence", + "targetJsonPath": "$.gradingPeriodReference.periodSequence" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolId", + "targetJsonPath": "$.gradingPeriodReference.schoolId" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolYear", + "targetJsonPath": "$.gradingPeriodReference.schoolYear" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + }, + { + "sourceJsonPath": "$.studentLearningObjectives[*].studentLearningObjectiveReference.gradingPeriodDescriptor", + "targetJsonPath": "$.gradingPeriodReference.gradingPeriodDescriptor" + }, + { + "sourceJsonPath": "$.studentLearningObjectives[*].studentLearningObjectiveReference.periodSequence", + "targetJsonPath": "$.gradingPeriodReference.periodSequence" + }, + { + "sourceJsonPath": "$.studentLearningObjectives[*].studentLearningObjectiveReference.schoolId", + "targetJsonPath": "$.gradingPeriodReference.schoolId" + }, + { + "sourceJsonPath": "$.studentLearningObjectives[*].studentLearningObjectiveReference.schoolYear", + "targetJsonPath": "$.gradingPeriodReference.schoolYear" + }, + { + "sourceJsonPath": "$.studentLearningObjectives[*].studentLearningObjectiveReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "Student", + "EducationOrganization", + "GradingPeriod" + ], + "documentPathsMapping": { + "Grade": [ + "$.grades[*].gradeReference.beginDate", + "$.grades[*].gradeReference.gradeTypeDescriptor", + "$.grades[*].gradeReference.gradingPeriodDescriptor", + "$.grades[*].gradeReference.localCourseCode", + "$.grades[*].gradeReference.periodSequence", + "$.grades[*].gradeReference.schoolId", + "$.grades[*].gradeReference.schoolYear", + "$.grades[*].gradeReference.sectionIdentifier", + "$.grades[*].gradeReference.sessionName", + "$.grades[*].gradeReference.studentUniqueId" + ], + "StudentCompetencyObjective": [ + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.educationOrganizationId", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.gradingPeriodDescriptor", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.objective", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.objectiveGradeLevelDescriptor", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.periodSequence", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolId", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolYear", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.studentUniqueId" + ], + "StudentLearningObjective": [ + "$.studentLearningObjectives[*].studentLearningObjectiveReference.gradingPeriodDescriptor", + "$.studentLearningObjectives[*].studentLearningObjectiveReference.learningObjectiveId", + "$.studentLearningObjectives[*].studentLearningObjectiveReference.namespace", + "$.studentLearningObjectives[*].studentLearningObjectiveReference.periodSequence", + "$.studentLearningObjectives[*].studentLearningObjectiveReference.schoolId", + "$.studentLearningObjectives[*].studentLearningObjectiveReference.schoolYear", + "$.studentLearningObjectives[*].studentLearningObjectiveReference.studentUniqueId" + ], + "GPAGivenGradingPeriod": [ + "$.gpaGivenGradingPeriod" + ], + "GPACumulative": [ + "$.gpaCumulative" + ], + "NumberOfDaysAbsent": [ + "$.numberOfDaysAbsent" + ], + "NumberOfDaysInAttendance": [ + "$.numberOfDaysInAttendance" + ], + "NumberOfDaysTardy": [ + "$.numberOfDaysTardy" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ] + } + }, + "restraintEvents": { + "resourceName": "RestraintEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.RestraintEvent", + "description": "This event entity represents the instances where a special education student was physically or mechanically restrained due to imminent serious physical harm to themselves or others, imminent serious property destruction or a combination of both imminent serious physical harm to themselves or others and imminent serious property destruction.", + "type": "object", + "properties": { + "restraintEventIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a restraint event by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the RestraintEvent." + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting where the RestraintEvent was exercised." + }, + "reasons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "restraintEventReasonDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "restraintEventReasonDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "restraintEventIdentifier", + "eventDate", + "studentReference", + "schoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.RestraintEvent", + "description": "This event entity represents the instances where a special education student was physically or mechanically restrained due to imminent serious physical harm to themselves or others, imminent serious property destruction or a combination of both imminent serious physical harm to themselves or others and imminent serious property destruction.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "restraintEventIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a restraint event by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the RestraintEvent." + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting where the RestraintEvent was exercised." + }, + "reasons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "restraintEventReasonDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "restraintEventReasonDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "restraintEventIdentifier", + "eventDate", + "studentReference", + "schoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.RestraintEvent", + "description": "This event entity represents the instances where a special education student was physically or mechanically restrained due to imminent serious physical harm to themselves or others, imminent serious property destruction or a combination of both imminent serious physical harm to themselves or others and imminent serious property destruction.", + "type": "object", + "properties": { + "restraintEventIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a restraint event by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the RestraintEvent." + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting where the RestraintEvent was exercised." + }, + "reasons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "restraintEventReasonDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "restraintEventReasonDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "RestraintEventIdentifier", + "Student", + "School" + ], + "documentPathsMapping": { + "RestraintEventIdentifier": [ + "$.restraintEventIdentifier" + ], + "EventDate": [ + "$.eventDate" + ], + "EducationalEnvironment": [ + "$.educationalEnvironmentDescriptor" + ], + "RestraintEventReason": [ + "$.reasons[*].restraintEventReasonDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programs[*].programReference.educationOrganizationId", + "$.programs[*].programReference.programName", + "$.programs[*].programReference.programTypeDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ] + } + }, + "sections": { + "resourceName": "Section", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Section", + "description": "This entity represents a setting in which organized instruction of course content is provided, in-person or otherwise, to one or more students for a given period of time. A course offering may be offered to more than one section.", + "type": "object", + "properties": { + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sequenceOfCourse": { + "type": "integer", + "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.", + "minimum": 1, + "maximum": 8 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "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 ..." + }, + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "The media through which teachers provide instruction to students and students and teachers communicate about instructional matters; for example: Technology-based instruction in classroom Correspondence instruction Face-to-face instruction Virtual/On-line Distance learning Center-based instruction ..." + }, + "populationServedDescriptor": { + "type": "string", + "description": "The type of students the Section is offered and tailored to; for example: Bilingual students Remedial education students Gifted and talented students Career and Technical Education students Special education students ..." + }, + "availableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "availableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "availableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sectionCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "instructionLanguageDescriptor": { + "type": "string", + "description": "The primary language of instruction, if omitted English is assumed." + }, + "courseOfferingReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "locationSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "locationReference": { + "type": "object", + "properties": { + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classroomIdentificationCode", + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this section is used for official daily attendance. Alternatively, official daily attendance may be tied to a Class Period." + }, + "sectionName": { + "type": "string", + "description": "A locally-defined name for the section, generally created to make the section more recognizable in informal contexts and generally distinct from the SectionIdentifier.", + "minLength": 1, + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "sectionIdentifier", + "courseOfferingReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Section", + "description": "This entity represents a setting in which organized instruction of course content is provided, in-person or otherwise, to one or more students for a given period of time. A course offering may be offered to more than one section.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sequenceOfCourse": { + "type": "integer", + "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.", + "minimum": 1, + "maximum": 8 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "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 ..." + }, + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "The media through which teachers provide instruction to students and students and teachers communicate about instructional matters; for example: Technology-based instruction in classroom Correspondence instruction Face-to-face instruction Virtual/On-line Distance learning Center-based instruction ..." + }, + "populationServedDescriptor": { + "type": "string", + "description": "The type of students the Section is offered and tailored to; for example: Bilingual students Remedial education students Gifted and talented students Career and Technical Education students Special education students ..." + }, + "availableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "availableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "availableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sectionCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "instructionLanguageDescriptor": { + "type": "string", + "description": "The primary language of instruction, if omitted English is assumed." + }, + "courseOfferingReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "locationSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "locationReference": { + "type": "object", + "properties": { + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classroomIdentificationCode", + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this section is used for official daily attendance. Alternatively, official daily attendance may be tied to a Class Period." + }, + "sectionName": { + "type": "string", + "description": "A locally-defined name for the section, generally created to make the section more recognizable in informal contexts and generally distinct from the SectionIdentifier.", + "minLength": 1, + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "sectionIdentifier", + "courseOfferingReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Section", + "description": "This entity represents a setting in which organized instruction of course content is provided, in-person or otherwise, to one or more students for a given period of time. A course offering may be offered to more than one section.", + "type": "object", + "properties": { + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sequenceOfCourse": { + "type": "integer", + "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.", + "minimum": 1, + "maximum": 8 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "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 ..." + }, + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "The media through which teachers provide instruction to students and students and teachers communicate about instructional matters; for example: Technology-based instruction in classroom Correspondence instruction Face-to-face instruction Virtual/On-line Distance learning Center-based instruction ..." + }, + "populationServedDescriptor": { + "type": "string", + "description": "The type of students the Section is offered and tailored to; for example: Bilingual students Remedial education students Gifted and talented students Career and Technical Education students Special education students ..." + }, + "availableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "availableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "availableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sectionCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "instructionLanguageDescriptor": { + "type": "string", + "description": "The primary language of instruction, if omitted English is assumed." + }, + "courseOfferingReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "locationSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "locationReference": { + "type": "object", + "properties": { + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classroomIdentificationCode", + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this section is used for official daily attendance. Alternatively, official daily attendance may be tied to a Class Period." + }, + "sectionName": { + "type": "string", + "description": "A locally-defined name for the section, generally created to make the section more recognizable in informal contexts and generally distinct from the SectionIdentifier.", + "minLength": 1, + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.classPeriods[*].classPeriodReference.schoolId", + "targetJsonPath": "$.courseOfferingReference.schoolId" + } + ], + "identityFullnames": [ + "SectionIdentifier", + "CourseOffering" + ], + "documentPathsMapping": { + "SectionIdentifier": [ + "$.sectionIdentifier" + ], + "SequenceOfCourse": [ + "$.sequenceOfCourse" + ], + "EducationalEnvironment": [ + "$.educationalEnvironmentDescriptor" + ], + "MediumOfInstruction": [ + "$.mediumOfInstructionDescriptor" + ], + "PopulationServed": [ + "$.populationServedDescriptor" + ], + "SectionCharacteristic": [ + "$.characteristics[*].sectionCharacteristicDescriptor" + ], + "InstructionLanguage": [ + "$.instructionLanguageDescriptor" + ], + "CourseOffering": [ + "$.courseOfferingReference.localCourseCode", + "$.courseOfferingReference.schoolId", + "$.courseOfferingReference.schoolYear", + "$.courseOfferingReference.sessionName" + ], + "LocationSchool": [ + "$.locationSchoolReference.schoolId" + ], + "Location": [ + "$.locationReference.classroomIdentificationCode", + "$.locationReference.schoolId" + ], + "ClassPeriod": [ + "$.classPeriods[*].classPeriodReference.classPeriodName", + "$.classPeriods[*].classPeriodReference.schoolId" + ], + "Program": [ + "$.programs[*].programReference.educationOrganizationId", + "$.programs[*].programReference.programName", + "$.programs[*].programReference.programTypeDescriptor" + ], + "CourseLevelCharacteristic": [ + "$.courseLevelCharacteristics[*].courseLevelCharacteristicDescriptor" + ], + "OfferedGradeLevel": [ + "$.offeredGradeLevels[*].gradeLevelDescriptor" + ], + "OfficialAttendancePeriod": [ + "$.officialAttendancePeriod" + ], + "SectionName": [ + "$.sectionName" + ] + } + }, + "sectionAttendanceTakenEvents": { + "resourceName": "SectionAttendanceTakenEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SectionAttendanceTakenEvent", + "description": "Captures attendance taken event for given section.", + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "calendarDateReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the CalendarEvent." + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear", + "date" + ] + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the SectionAttendanceTakenEvent was submitted, which could be a different date than the instructional day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "sectionReference", + "calendarDateReference", + "eventDate" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SectionAttendanceTakenEvent", + "description": "Captures attendance taken event for given section.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "calendarDateReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the CalendarEvent." + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear", + "date" + ] + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the SectionAttendanceTakenEvent was submitted, which could be a different date than the instructional day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "sectionReference", + "calendarDateReference", + "eventDate" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SectionAttendanceTakenEvent", + "description": "Captures attendance taken event for given section.", + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "calendarDateReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the Calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the CalendarEvent." + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear", + "date" + ] + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the SectionAttendanceTakenEvent was submitted, which could be a different date than the instructional day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.calendarDateReference.schoolId", + "targetJsonPath": "$.sectionReference.schoolId" + }, + { + "sourceJsonPath": "$.calendarDateReference.schoolYear", + "targetJsonPath": "$.sectionReference.schoolYear" + } + ], + "identityFullnames": [ + "Section", + "CalendarDate" + ], + "documentPathsMapping": { + "Section": [ + "$.sectionReference.localCourseCode", + "$.sectionReference.schoolId", + "$.sectionReference.schoolYear", + "$.sectionReference.sectionIdentifier", + "$.sectionReference.sessionName" + ], + "CalendarDate": [ + "$.calendarDateReference.calendarCode", + "$.calendarDateReference.date", + "$.calendarDateReference.schoolId", + "$.calendarDateReference.schoolYear" + ], + "EventDate": [ + "$.eventDate" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "sessions": { + "resourceName": "Session", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Session", + "description": "A term in the school year, generally a unit of time into which courses are scheduled, instruction occurs and by which credits are awarded. Sessions may be interrupted by vacations or other events.", + "type": "object", + "properties": { + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the Session." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day and year of the last day of the Session." + }, + "termDescriptor": { + "type": "string", + "description": "An descriptor value indicating the term (e.g. 'Semester', 'Quarter', etc.)." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total number of instructional days in the school calendar.", + "minimum": 0 + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicWeeks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicWeekReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "weekIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "academicWeekReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "sessionName", + "schoolYearTypeReference", + "beginDate", + "endDate", + "termDescriptor", + "totalInstructionalDays", + "schoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Session", + "description": "A term in the school year, generally a unit of time into which courses are scheduled, instruction occurs and by which credits are awarded. Sessions may be interrupted by vacations or other events.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the Session." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day and year of the last day of the Session." + }, + "termDescriptor": { + "type": "string", + "description": "An descriptor value indicating the term (e.g. 'Semester', 'Quarter', etc.)." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total number of instructional days in the school calendar.", + "minimum": 0 + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicWeeks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicWeekReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "weekIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "academicWeekReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "sessionName", + "schoolYearTypeReference", + "beginDate", + "endDate", + "termDescriptor", + "totalInstructionalDays", + "schoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Session", + "description": "A term in the school year, generally a unit of time into which courses are scheduled, instruction occurs and by which credits are awarded. Sessions may be interrupted by vacations or other events.", + "type": "object", + "properties": { + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the Session." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day and year of the last day of the Session." + }, + "termDescriptor": { + "type": "string", + "description": "An descriptor value indicating the term (e.g. 'Semester', 'Quarter', etc.)." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total number of instructional days in the school calendar.", + "minimum": 0 + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicWeeks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicWeekReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "weekIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "academicWeekReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.gradingPeriods[*].gradingPeriodReference.schoolYear", + "targetJsonPath": "$.schoolYearTypeReference.schoolYear" + }, + { + "sourceJsonPath": "$.gradingPeriods[*].gradingPeriodReference.schoolId", + "targetJsonPath": "$.schoolReference.schoolId" + } + ], + "identityFullnames": [ + "SessionName", + "SchoolYear", + "School" + ], + "documentPathsMapping": { + "SessionName": [ + "$.sessionName" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "Term": [ + "$.termDescriptor" + ], + "TotalInstructionalDays": [ + "$.totalInstructionalDays" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "GradingPeriod": [ + "$.gradingPeriods[*].gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriods[*].gradingPeriodReference.periodSequence", + "$.gradingPeriods[*].gradingPeriodReference.schoolId", + "$.gradingPeriods[*].gradingPeriodReference.schoolYear" + ], + "AcademicWeek": [ + "$.academicWeeks[*].academicWeekReference.schoolId", + "$.academicWeeks[*].academicWeekReference.weekIdentifier" + ] + } + }, + "staffs": { + "resourceName": "Staff", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Staff", + "description": "This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. For example, this includes: 1. An \"employee\" who performs services under the direction of the employing institution or agency is compensated for such services by the employer and is eligible for employee benefits and wage or salary tax withholdings 2. A \"contractor\" or \"consultant\" who performs services for an agreed upon fee or an employee of a management service contracted to work on site 3. A \"volunteer\" who performs services on a voluntary and uncompensated basis 4. An in-kind service provider 5. An independent contractor or businessperson working at a school site.", + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "staffIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the staff Identification Code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "staffIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "hispanicLatinoEthnicity": { + "type": "boolean", + "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.\"" + }, + "oldEthnicityDescriptor": { + "type": "string", + "description": "Previous definition of Ethnicity combining Hispanic/Latino and race: 1 - American Indian or Alaskan Native 2 - Asian or Pacific Islander 3 - Black, not of Hispanic origin 4 - Hispanic 5 - White, not of Hispanic origin." + }, + "races": { + "type": "array", + "items": { + "type": "object", + "properties": { + "raceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "raceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "yearsOfPriorProfessionalExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a similar professional position in one or more education institutions." + }, + "yearsOfPriorTeachingExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a teaching position in one or more education institutions." + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "highlyQualifiedTeacher": { + "type": "boolean", + "description": "An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL Sections being taught." + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the learner for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "credentials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credentialReference": { + "type": "object", + "properties": { + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "credentialReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "tribalAffiliations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tribalAffiliationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "tribalAffiliationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "ancestryEthnicOrigins": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ancestryEthnicOriginDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "ancestryEthnicOriginDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Staff", + "description": "This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. For example, this includes: 1. An \"employee\" who performs services under the direction of the employing institution or agency is compensated for such services by the employer and is eligible for employee benefits and wage or salary tax withholdings 2. A \"contractor\" or \"consultant\" who performs services for an agreed upon fee or an employee of a management service contracted to work on site 3. A \"volunteer\" who performs services on a voluntary and uncompensated basis 4. An in-kind service provider 5. An independent contractor or businessperson working at a school site.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "staffIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the staff Identification Code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "staffIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "hispanicLatinoEthnicity": { + "type": "boolean", + "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.\"" + }, + "oldEthnicityDescriptor": { + "type": "string", + "description": "Previous definition of Ethnicity combining Hispanic/Latino and race: 1 - American Indian or Alaskan Native 2 - Asian or Pacific Islander 3 - Black, not of Hispanic origin 4 - Hispanic 5 - White, not of Hispanic origin." + }, + "races": { + "type": "array", + "items": { + "type": "object", + "properties": { + "raceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "raceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "yearsOfPriorProfessionalExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a similar professional position in one or more education institutions." + }, + "yearsOfPriorTeachingExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a teaching position in one or more education institutions." + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "highlyQualifiedTeacher": { + "type": "boolean", + "description": "An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL Sections being taught." + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the learner for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "credentials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credentialReference": { + "type": "object", + "properties": { + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "credentialReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "tribalAffiliations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tribalAffiliationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "tribalAffiliationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "ancestryEthnicOrigins": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ancestryEthnicOriginDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "ancestryEthnicOriginDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "staffUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Staff", + "description": "This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. For example, this includes: 1. An \"employee\" who performs services under the direction of the employing institution or agency is compensated for such services by the employer and is eligible for employee benefits and wage or salary tax withholdings 2. A \"contractor\" or \"consultant\" who performs services for an agreed upon fee or an employee of a management service contracted to work on site 3. A \"volunteer\" who performs services on a voluntary and uncompensated basis 4. An in-kind service provider 5. An independent contractor or businessperson working at a school site.", + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "staffIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the staff Identification Code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "staffIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "hispanicLatinoEthnicity": { + "type": "boolean", + "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.\"" + }, + "oldEthnicityDescriptor": { + "type": "string", + "description": "Previous definition of Ethnicity combining Hispanic/Latino and race: 1 - American Indian or Alaskan Native 2 - Asian or Pacific Islander 3 - Black, not of Hispanic origin 4 - Hispanic 5 - White, not of Hispanic origin." + }, + "races": { + "type": "array", + "items": { + "type": "object", + "properties": { + "raceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "raceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "yearsOfPriorProfessionalExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a similar professional position in one or more education institutions." + }, + "yearsOfPriorTeachingExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a teaching position in one or more education institutions." + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "highlyQualifiedTeacher": { + "type": "boolean", + "description": "An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL Sections being taught." + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the learner for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "credentials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credentialReference": { + "type": "object", + "properties": { + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "credentialReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "tribalAffiliations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tribalAffiliationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "tribalAffiliationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "ancestryEthnicOrigins": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ancestryEthnicOriginDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "ancestryEthnicOriginDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "StaffUniqueId" + ], + "documentPathsMapping": { + "StaffUniqueId": [ + "$.staffUniqueId" + ], + "Sex": [ + "$.sexDescriptor" + ], + "BirthDate": [ + "$.birthDate" + ], + "HispanicLatinoEthnicity": [ + "$.hispanicLatinoEthnicity" + ], + "OldEthnicity": [ + "$.oldEthnicityDescriptor" + ], + "Race": [ + "$.races[*].raceDescriptor" + ], + "HighestCompletedLevelOfEducation": [ + "$.highestCompletedLevelOfEducationDescriptor" + ], + "YearsOfPriorProfessionalExperience": [ + "$.yearsOfPriorProfessionalExperience" + ], + "YearsOfPriorTeachingExperience": [ + "$.yearsOfPriorTeachingExperience" + ], + "LoginId": [ + "$.loginId" + ], + "HighlyQualifiedTeacher": [ + "$.highlyQualifiedTeacher" + ], + "Credential": [ + "$.credentials[*].credentialReference.credentialIdentifier", + "$.credentials[*].credentialReference.stateOfIssueStateAbbreviationDescriptor" + ], + "TribalAffiliation": [ + "$.tribalAffiliations[*].tribalAffiliationDescriptor" + ], + "Person": [ + "$.personReference.personId", + "$.personReference.sourceSystemDescriptor" + ], + "AncestryEthnicOrigin": [ + "$.ancestryEthnicOrigins[*].ancestryEthnicOriginDescriptor" + ] + } + }, + "staffAbsenceEvents": { + "resourceName": "StaffAbsenceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffAbsenceEvent", + "description": "This event entity represents the recording of the dates of staff absence.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this leave event." + }, + "absenceEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of absence." + }, + "absenceEventReason": { + "type": "string", + "description": "Expanded reason for the staff absence.", + "minLength": 1, + "maxLength": 40 + }, + "hoursAbsent": { + "type": "number", + "description": "The hours the staff was absent, if not the entire working day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "absenceEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffAbsenceEvent", + "description": "This event entity represents the recording of the dates of staff absence.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this leave event." + }, + "absenceEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of absence." + }, + "absenceEventReason": { + "type": "string", + "description": "Expanded reason for the staff absence.", + "minLength": 1, + "maxLength": 40 + }, + "hoursAbsent": { + "type": "number", + "description": "The hours the staff was absent, if not the entire working day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "absenceEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffAbsenceEvent", + "description": "This event entity represents the recording of the dates of staff absence.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this leave event." + }, + "absenceEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of absence." + }, + "absenceEventReason": { + "type": "string", + "description": "Expanded reason for the staff absence.", + "minLength": 1, + "maxLength": 40 + }, + "hoursAbsent": { + "type": "number", + "description": "The hours the staff was absent, if not the entire working day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EventDate", + "AbsenceEventCategory", + "Staff" + ], + "documentPathsMapping": { + "EventDate": [ + "$.eventDate" + ], + "AbsenceEventCategory": [ + "$.absenceEventCategoryDescriptor" + ], + "AbsenceEventReason": [ + "$.absenceEventReason" + ], + "HoursAbsent": [ + "$.hoursAbsent" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "staffLeaves": { + "resourceName": "StaffLeave", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffLeave", + "description": "This entity represents the recording of the dates of staff leave (e.g., sick leave, personal time, vacation).", + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The begin date of the staff leave." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the staff leave." + }, + "staffLeaveEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of leave taken, for example: Sick, Personal, Vacation." + }, + "reason": { + "type": "string", + "description": "Expanded reason for the staff leave.", + "minLength": 1, + "maxLength": 40 + }, + "substituteAssigned": { + "type": "boolean", + "description": "Indicator of whether a substitute was assigned during the period of staff leave." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffLeave", + "description": "This entity represents the recording of the dates of staff leave (e.g., sick leave, personal time, vacation).", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The begin date of the staff leave." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the staff leave." + }, + "staffLeaveEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of leave taken, for example: Sick, Personal, Vacation." + }, + "reason": { + "type": "string", + "description": "Expanded reason for the staff leave.", + "minLength": 1, + "maxLength": 40 + }, + "substituteAssigned": { + "type": "boolean", + "description": "Indicator of whether a substitute was assigned during the period of staff leave." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffLeave", + "description": "This entity represents the recording of the dates of staff leave (e.g., sick leave, personal time, vacation).", + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The begin date of the staff leave." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the staff leave." + }, + "staffLeaveEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of leave taken, for example: Sick, Personal, Vacation." + }, + "reason": { + "type": "string", + "description": "Expanded reason for the staff leave.", + "minLength": 1, + "maxLength": 40 + }, + "substituteAssigned": { + "type": "boolean", + "description": "Indicator of whether a substitute was assigned during the period of staff leave." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "StaffLeaveEventCategory", + "Staff" + ], + "documentPathsMapping": { + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "StaffLeaveEventCategory": [ + "$.staffLeaveEventCategoryDescriptor" + ], + "Reason": [ + "$.reason" + ], + "SubstituteAssigned": [ + "$.substituteAssigned" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "students": { + "resourceName": "Student", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Student", + "description": "This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.", + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "birthCity": { + "type": "string", + "description": "The city the student was born in.", + "minLength": 2, + "maxLength": 30 + }, + "birthStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born." + }, + "birthInternationalProvince": { + "type": "string", + "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", + "minLength": 1, + "maxLength": 150 + }, + "birthCountryDescriptor": { + "type": "string", + "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "dateEnteredUS": { + "type": "string", + "format": "date", + "description": "For students born outside of the U.S., the date the student entered the U.S." + }, + "multipleBirthStatus": { + "type": "boolean", + "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)" + }, + "birthSexDescriptor": { + "type": "string", + "description": "A person's gender at birth." + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId", + "firstName", + "lastSurname", + "birthDate" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Student", + "description": "This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "birthCity": { + "type": "string", + "description": "The city the student was born in.", + "minLength": 2, + "maxLength": 30 + }, + "birthStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born." + }, + "birthInternationalProvince": { + "type": "string", + "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", + "minLength": 1, + "maxLength": 150 + }, + "birthCountryDescriptor": { + "type": "string", + "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "dateEnteredUS": { + "type": "string", + "format": "date", + "description": "For students born outside of the U.S., the date the student entered the U.S." + }, + "multipleBirthStatus": { + "type": "boolean", + "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)" + }, + "birthSexDescriptor": { + "type": "string", + "description": "A person's gender at birth." + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentUniqueId", + "firstName", + "lastSurname", + "birthDate" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Student", + "description": "This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.", + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The person's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the person.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for a person." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "birthCity": { + "type": "string", + "description": "The city the student was born in.", + "minLength": 2, + "maxLength": 30 + }, + "birthStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born." + }, + "birthInternationalProvince": { + "type": "string", + "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", + "minLength": 1, + "maxLength": 150 + }, + "birthCountryDescriptor": { + "type": "string", + "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "dateEnteredUS": { + "type": "string", + "format": "date", + "description": "For students born outside of the U.S., the date the student entered the U.S." + }, + "multipleBirthStatus": { + "type": "boolean", + "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)" + }, + "birthSexDescriptor": { + "type": "string", + "description": "A person's gender at birth." + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "StudentUniqueId" + ], + "documentPathsMapping": { + "StudentUniqueId": [ + "$.studentUniqueId" + ], + "Person": [ + "$.personReference.personId", + "$.personReference.sourceSystemDescriptor" + ] + } + }, + "studentAcademicRecords": { + "resourceName": "StudentAcademicRecord", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAcademicRecord", + "description": "This educational entity represents the cumulative record of academic achievement for a student.", + "type": "object", + "properties": { + "cumulativeEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeGradePointsEarned": { + "type": "number", + "description": "The cumulative number of grade points an individual earns by successfully completing courses or examinations during his or her enrollment in the current school as well as those transferred from schools in which the individual had been previously enrolled." + }, + "cumulativeGradePointAverage": { + "type": "number", + "description": "A measure of average performance in all courses taken by an individual during his or her school career as determined for record-keeping purposes. This is obtained by dividing the total grade points received by the total number of credits attempted. This usually includes grade points received and credits attempted in his or her current school as well as those transferred from schools in which the individual was previously enrolled." + }, + "gradeValueQualifier": { + "type": "string", + "description": "The scale of equivalents, if applicable, for grades awarded as indicators of performance in schoolwork. For example, numerical equivalents for letter grades used in determining a student's Grade Point Average (A=4, B=3, C=2, D=1 in a four-point system) or letter equivalents for percentage grades (90-100%=A, 80-90%=B, etc.)", + "minLength": 1, + "maxLength": 80 + }, + "classRanking": { + "type": "object", + "properties": { + "classRank": { + "type": "integer", + "description": "The academic rank of a student in relation to his or her graduating class (e.g., 1st, 2nd, 3rd)." + }, + "totalNumberInClass": { + "type": "integer", + "description": "The total number of students in the student's graduating class." + }, + "percentageRanking": { + "type": "integer", + "description": "The academic percentage rank of a student in relation to his or her graduating class (e.g., 95%, 80%, 50%)." + }, + "classRankingDate": { + "type": "string", + "format": "date", + "description": "Date class ranking was determined." + } + }, + "additionalProperties": false, + "required": [ + "classRank", + "totalNumberInClass" + ] + }, + "academicHonors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "academicHonorCategoryDescriptor": { + "type": "string", + "description": "A designation of the type of academic distinctions earned by or awarded to the student." + }, + "honorDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "honorAwardDate": { + "type": "string", + "format": "date", + "description": "The date the honor was awarded or earned." + }, + "honorAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "academicHonorCategoryDescriptor", + "honorDescription" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the learner for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "projectedGraduationDate": { + "type": "string", + "format": "date", + "description": "The month and year the student is projected to graduate." + }, + "sessionEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionGradePointsEarned": { + "type": "number", + "description": "The number of grade points an individual earned for this session." + }, + "sessionGradePointAverage": { + "type": "number", + "description": "The grade point average for an individual computed as the grade points earned during the session divided by the number of credits attempted." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "diplomas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "diplomaAwardDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student met graduation requirements and was awarded a diploma." + }, + "diplomaLevelDescriptor": { + "type": "string", + "description": "The level of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements. Minimum high school program Recommended high school program Distinguished Achievement Program." + }, + "diplomaTypeDescriptor": { + "type": "string", + "description": "The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements." + }, + "cteCompleter": { + "type": "boolean", + "description": "Indicated a student who reached a state-defined threshold of vocational education and who attained a high school diploma or its recognized state equivalent or GED." + }, + "diplomaDescription": { + "type": "string", + "description": "The description of diploma given to the student for accomplishments.", + "minLength": 1, + "maxLength": 80 + }, + "diplomaAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "diplomaAwardDate", + "diplomaTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + }, + "reportCards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportCardReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "reportCardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "educationOrganizationReference", + "schoolYearTypeReference", + "termDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAcademicRecord", + "description": "This educational entity represents the cumulative record of academic achievement for a student.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "cumulativeEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeGradePointsEarned": { + "type": "number", + "description": "The cumulative number of grade points an individual earns by successfully completing courses or examinations during his or her enrollment in the current school as well as those transferred from schools in which the individual had been previously enrolled." + }, + "cumulativeGradePointAverage": { + "type": "number", + "description": "A measure of average performance in all courses taken by an individual during his or her school career as determined for record-keeping purposes. This is obtained by dividing the total grade points received by the total number of credits attempted. This usually includes grade points received and credits attempted in his or her current school as well as those transferred from schools in which the individual was previously enrolled." + }, + "gradeValueQualifier": { + "type": "string", + "description": "The scale of equivalents, if applicable, for grades awarded as indicators of performance in schoolwork. For example, numerical equivalents for letter grades used in determining a student's Grade Point Average (A=4, B=3, C=2, D=1 in a four-point system) or letter equivalents for percentage grades (90-100%=A, 80-90%=B, etc.)", + "minLength": 1, + "maxLength": 80 + }, + "classRanking": { + "type": "object", + "properties": { + "classRank": { + "type": "integer", + "description": "The academic rank of a student in relation to his or her graduating class (e.g., 1st, 2nd, 3rd)." + }, + "totalNumberInClass": { + "type": "integer", + "description": "The total number of students in the student's graduating class." + }, + "percentageRanking": { + "type": "integer", + "description": "The academic percentage rank of a student in relation to his or her graduating class (e.g., 95%, 80%, 50%)." + }, + "classRankingDate": { + "type": "string", + "format": "date", + "description": "Date class ranking was determined." + } + }, + "additionalProperties": false, + "required": [ + "classRank", + "totalNumberInClass" + ] + }, + "academicHonors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "academicHonorCategoryDescriptor": { + "type": "string", + "description": "A designation of the type of academic distinctions earned by or awarded to the student." + }, + "honorDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "honorAwardDate": { + "type": "string", + "format": "date", + "description": "The date the honor was awarded or earned." + }, + "honorAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "academicHonorCategoryDescriptor", + "honorDescription" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the learner for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "projectedGraduationDate": { + "type": "string", + "format": "date", + "description": "The month and year the student is projected to graduate." + }, + "sessionEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionGradePointsEarned": { + "type": "number", + "description": "The number of grade points an individual earned for this session." + }, + "sessionGradePointAverage": { + "type": "number", + "description": "The grade point average for an individual computed as the grade points earned during the session divided by the number of credits attempted." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "diplomas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "diplomaAwardDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student met graduation requirements and was awarded a diploma." + }, + "diplomaLevelDescriptor": { + "type": "string", + "description": "The level of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements. Minimum high school program Recommended high school program Distinguished Achievement Program." + }, + "diplomaTypeDescriptor": { + "type": "string", + "description": "The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements." + }, + "cteCompleter": { + "type": "boolean", + "description": "Indicated a student who reached a state-defined threshold of vocational education and who attained a high school diploma or its recognized state equivalent or GED." + }, + "diplomaDescription": { + "type": "string", + "description": "The description of diploma given to the student for accomplishments.", + "minLength": 1, + "maxLength": 80 + }, + "diplomaAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "diplomaAwardDate", + "diplomaTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + }, + "reportCards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportCardReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "reportCardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "educationOrganizationReference", + "schoolYearTypeReference", + "termDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAcademicRecord", + "description": "This educational entity represents the cumulative record of academic achievement for a student.", + "type": "object", + "properties": { + "cumulativeEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeGradePointsEarned": { + "type": "number", + "description": "The cumulative number of grade points an individual earns by successfully completing courses or examinations during his or her enrollment in the current school as well as those transferred from schools in which the individual had been previously enrolled." + }, + "cumulativeGradePointAverage": { + "type": "number", + "description": "A measure of average performance in all courses taken by an individual during his or her school career as determined for record-keeping purposes. This is obtained by dividing the total grade points received by the total number of credits attempted. This usually includes grade points received and credits attempted in his or her current school as well as those transferred from schools in which the individual was previously enrolled." + }, + "gradeValueQualifier": { + "type": "string", + "description": "The scale of equivalents, if applicable, for grades awarded as indicators of performance in schoolwork. For example, numerical equivalents for letter grades used in determining a student's Grade Point Average (A=4, B=3, C=2, D=1 in a four-point system) or letter equivalents for percentage grades (90-100%=A, 80-90%=B, etc.)", + "minLength": 1, + "maxLength": 80 + }, + "classRanking": { + "type": "object", + "properties": { + "classRank": { + "type": "integer", + "description": "The academic rank of a student in relation to his or her graduating class (e.g., 1st, 2nd, 3rd)." + }, + "totalNumberInClass": { + "type": "integer", + "description": "The total number of students in the student's graduating class." + }, + "percentageRanking": { + "type": "integer", + "description": "The academic percentage rank of a student in relation to his or her graduating class (e.g., 95%, 80%, 50%)." + }, + "classRankingDate": { + "type": "string", + "format": "date", + "description": "Date class ranking was determined." + } + }, + "additionalProperties": false, + "required": [ + "classRank", + "totalNumberInClass" + ] + }, + "academicHonors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "academicHonorCategoryDescriptor": { + "type": "string", + "description": "A designation of the type of academic distinctions earned by or awarded to the student." + }, + "honorDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "honorAwardDate": { + "type": "string", + "format": "date", + "description": "The date the honor was awarded or earned." + }, + "honorAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "academicHonorCategoryDescriptor", + "honorDescription" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the learner for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "projectedGraduationDate": { + "type": "string", + "format": "date", + "description": "The month and year the student is projected to graduate." + }, + "sessionEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionGradePointsEarned": { + "type": "number", + "description": "The number of grade points an individual earned for this session." + }, + "sessionGradePointAverage": { + "type": "number", + "description": "The grade point average for an individual computed as the grade points earned during the session divided by the number of credits attempted." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "diplomas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the learner." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the learner.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the learner met the criteria for attainment of the Achievement.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the Achievement.", + "minLength": 5, + "maxLength": 255 + }, + "diplomaAwardDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student met graduation requirements and was awarded a diploma." + }, + "diplomaLevelDescriptor": { + "type": "string", + "description": "The level of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements. Minimum high school program Recommended high school program Distinguished Achievement Program." + }, + "diplomaTypeDescriptor": { + "type": "string", + "description": "The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements." + }, + "cteCompleter": { + "type": "boolean", + "description": "Indicated a student who reached a state-defined threshold of vocational education and who attained a high school diploma or its recognized state equivalent or GED." + }, + "diplomaDescription": { + "type": "string", + "description": "The description of diploma given to the student for accomplishments.", + "minLength": 1, + "maxLength": 80 + }, + "diplomaAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the award expires." + } + }, + "additionalProperties": false, + "required": [ + "diplomaAwardDate", + "diplomaTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + }, + "reportCards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportCardReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "reportCardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.reportCards[*].reportCardReference.educationOrganizationId", + "targetJsonPath": "$.educationOrganizationReference.educationOrganizationId" + }, + { + "sourceJsonPath": "$.reportCards[*].reportCardReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "Student", + "EducationOrganization", + "SchoolYear", + "Term" + ], + "documentPathsMapping": { + "CumulativeGradePointsEarned": [ + "$.cumulativeGradePointsEarned" + ], + "CumulativeGradePointAverage": [ + "$.cumulativeGradePointAverage" + ], + "GradeValueQualifier": [ + "$.gradeValueQualifier" + ], + "ProjectedGraduationDate": [ + "$.projectedGraduationDate" + ], + "SessionGradePointsEarned": [ + "$.sessionGradePointsEarned" + ], + "SessionGradePointAverage": [ + "$.sessionGradePointAverage" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "Term": [ + "$.termDescriptor" + ], + "ReportCard": [ + "$.reportCards[*].reportCardReference.educationOrganizationId", + "$.reportCards[*].reportCardReference.gradingPeriodDescriptor", + "$.reportCards[*].reportCardReference.periodSequence", + "$.reportCards[*].reportCardReference.schoolId", + "$.reportCards[*].reportCardReference.schoolYear", + "$.reportCards[*].reportCardReference.studentUniqueId" + ] + } + }, + "studentAssessments": { + "resourceName": "StudentAssessment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAssessment", + "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.", + "type": "object", + "properties": { + "studentAssessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment administered to a student.", + "minLength": 1, + "maxLength": 60 + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + }, + "serialNumber": { + "type": "string", + "description": "The unique number for the assessment form or answer document.", + "minLength": 1, + "maxLength": 60 + }, + "administrationLanguageDescriptor": { + "type": "string", + "description": "The language in which an assessment is written and/or administered." + }, + "administrationEnvironmentDescriptor": { + "type": "string", + "description": "The environment in which the test was administered." + }, + "accommodations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accommodationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "accommodationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "retestIndicatorDescriptor": { + "type": "string", + "description": "Indicator if the test was retaken. For example: Primary administration First retest Second retest ..." + }, + "reasonNotTestedDescriptor": { + "type": "string", + "description": "The primary reason student is not tested. For example: Absent Refusal by parent Refusal by student Medical waiver Illness Disruptive behavior LEP Exempt ..." + }, + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenAssessedGradeLevelDescriptor": { + "type": "string", + "description": "The grade level of a student when assessed." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelMet": { + "type": "boolean", + "description": "Indicator of whether the performance level was met." + }, + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelMet", + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "eventCircumstanceDescriptor": { + "type": "string", + "description": "An unusual event occurred during the administration of the assessment. This could include fire alarm, student became ill, etc." + }, + "eventDescription": { + "type": "string", + "description": "Describes special events that occur before during or after the assessment session that may impact use of results.", + "minLength": 1, + "maxLength": 1024 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentResponse": { + "type": "string", + "description": "A student's response to a stimulus on a test.", + "minLength": 1, + "maxLength": 60 + }, + "descriptiveFeedback": { + "type": "string", + "description": "The formative descriptive feedback that was given to a learner in response to the results from a scored/evaluated assessment item.", + "minLength": 1, + "maxLength": 1024 + }, + "responseIndicatorDescriptor": { + "type": "string", + "description": "Indicator of the response. For example: Nonscorable response Ineffective response Effective response Partial response ..." + }, + "assessmentItemResultDescriptor": { + "type": "string", + "description": "The analyzed result of a student's response to an assessment item. For example: Correct Incorrect Met standard ..." + }, + "rawScoreResult": { + "type": "number", + "description": "A meaningful raw score of the performance of an individual on an assessment item." + }, + "timeAssessed": { + "type": "number", + "description": "The overall time a student actually spent during the AssessmentItem." + }, + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemResultDescriptor", + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentObjectiveAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelMet": { + "type": "boolean", + "description": "Indicator of whether the performance level was met." + }, + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelMet", + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "scoreResults", + "objectiveAssessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "platformTypeDescriptor": { + "type": "string", + "description": "The platform with which the assessment was delivered to the student during the assessment session." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentAssessmentIdentifier", + "administrationDate", + "studentReference", + "assessmentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAssessment", + "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.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "studentAssessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment administered to a student.", + "minLength": 1, + "maxLength": 60 + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + }, + "serialNumber": { + "type": "string", + "description": "The unique number for the assessment form or answer document.", + "minLength": 1, + "maxLength": 60 + }, + "administrationLanguageDescriptor": { + "type": "string", + "description": "The language in which an assessment is written and/or administered." + }, + "administrationEnvironmentDescriptor": { + "type": "string", + "description": "The environment in which the test was administered." + }, + "accommodations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accommodationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "accommodationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "retestIndicatorDescriptor": { + "type": "string", + "description": "Indicator if the test was retaken. For example: Primary administration First retest Second retest ..." + }, + "reasonNotTestedDescriptor": { + "type": "string", + "description": "The primary reason student is not tested. For example: Absent Refusal by parent Refusal by student Medical waiver Illness Disruptive behavior LEP Exempt ..." + }, + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenAssessedGradeLevelDescriptor": { + "type": "string", + "description": "The grade level of a student when assessed." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelMet": { + "type": "boolean", + "description": "Indicator of whether the performance level was met." + }, + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelMet", + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "eventCircumstanceDescriptor": { + "type": "string", + "description": "An unusual event occurred during the administration of the assessment. This could include fire alarm, student became ill, etc." + }, + "eventDescription": { + "type": "string", + "description": "Describes special events that occur before during or after the assessment session that may impact use of results.", + "minLength": 1, + "maxLength": 1024 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentResponse": { + "type": "string", + "description": "A student's response to a stimulus on a test.", + "minLength": 1, + "maxLength": 60 + }, + "descriptiveFeedback": { + "type": "string", + "description": "The formative descriptive feedback that was given to a learner in response to the results from a scored/evaluated assessment item.", + "minLength": 1, + "maxLength": 1024 + }, + "responseIndicatorDescriptor": { + "type": "string", + "description": "Indicator of the response. For example: Nonscorable response Ineffective response Effective response Partial response ..." + }, + "assessmentItemResultDescriptor": { + "type": "string", + "description": "The analyzed result of a student's response to an assessment item. For example: Correct Incorrect Met standard ..." + }, + "rawScoreResult": { + "type": "number", + "description": "A meaningful raw score of the performance of an individual on an assessment item." + }, + "timeAssessed": { + "type": "number", + "description": "The overall time a student actually spent during the AssessmentItem." + }, + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemResultDescriptor", + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentObjectiveAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelMet": { + "type": "boolean", + "description": "Indicator of whether the performance level was met." + }, + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelMet", + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "scoreResults", + "objectiveAssessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "platformTypeDescriptor": { + "type": "string", + "description": "The platform with which the assessment was delivered to the student during the assessment session." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentAssessmentIdentifier", + "administrationDate", + "studentReference", + "assessmentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAssessment", + "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.", + "type": "object", + "properties": { + "studentAssessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment administered to a student.", + "minLength": 1, + "maxLength": 60 + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + }, + "serialNumber": { + "type": "string", + "description": "The unique number for the assessment form or answer document.", + "minLength": 1, + "maxLength": 60 + }, + "administrationLanguageDescriptor": { + "type": "string", + "description": "The language in which an assessment is written and/or administered." + }, + "administrationEnvironmentDescriptor": { + "type": "string", + "description": "The environment in which the test was administered." + }, + "accommodations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accommodationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "accommodationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "retestIndicatorDescriptor": { + "type": "string", + "description": "Indicator if the test was retaken. For example: Primary administration First retest Second retest ..." + }, + "reasonNotTestedDescriptor": { + "type": "string", + "description": "The primary reason student is not tested. For example: Absent Refusal by parent Refusal by student Medical waiver Illness Disruptive behavior LEP Exempt ..." + }, + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenAssessedGradeLevelDescriptor": { + "type": "string", + "description": "The grade level of a student when assessed." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelMet": { + "type": "boolean", + "description": "Indicator of whether the performance level was met." + }, + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelMet", + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "eventCircumstanceDescriptor": { + "type": "string", + "description": "An unusual event occurred during the administration of the assessment. This could include fire alarm, student became ill, etc." + }, + "eventDescription": { + "type": "string", + "description": "Describes special events that occur before during or after the assessment session that may impact use of results.", + "minLength": 1, + "maxLength": 1024 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentResponse": { + "type": "string", + "description": "A student's response to a stimulus on a test.", + "minLength": 1, + "maxLength": 60 + }, + "descriptiveFeedback": { + "type": "string", + "description": "The formative descriptive feedback that was given to a learner in response to the results from a scored/evaluated assessment item.", + "minLength": 1, + "maxLength": 1024 + }, + "responseIndicatorDescriptor": { + "type": "string", + "description": "Indicator of the response. For example: Nonscorable response Ineffective response Effective response Partial response ..." + }, + "assessmentItemResultDescriptor": { + "type": "string", + "description": "The analyzed result of a student's response to an assessment item. For example: Correct Incorrect Met standard ..." + }, + "rawScoreResult": { + "type": "number", + "description": "A meaningful raw score of the performance of an individual on an assessment item." + }, + "timeAssessed": { + "type": "number", + "description": "The overall time a student actually spent during the AssessmentItem." + }, + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemResultDescriptor", + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentObjectiveAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelMet": { + "type": "boolean", + "description": "Indicator of whether the performance level was met." + }, + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelMet", + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "scoreResults", + "objectiveAssessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "platformTypeDescriptor": { + "type": "string", + "description": "The platform with which the assessment was delivered to the student during the assessment session." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.items[*].assessmentItemReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.items[*].assessmentItemReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + }, + { + "sourceJsonPath": "$.studentObjectiveAssessments[*].objectiveAssessmentReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.studentObjectiveAssessments[*].objectiveAssessmentReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + } + ], + "identityFullnames": [ + "StudentAssessmentIdentifier", + "Student", + "Assessment" + ], + "documentPathsMapping": { + "StudentAssessmentIdentifier": [ + "$.studentAssessmentIdentifier" + ], + "AdministrationDate": [ + "$.administrationDate" + ], + "AdministrationEndDate": [ + "$.administrationEndDate" + ], + "SerialNumber": [ + "$.serialNumber" + ], + "AdministrationLanguage": [ + "$.administrationLanguageDescriptor" + ], + "AdministrationEnvironment": [ + "$.administrationEnvironmentDescriptor" + ], + "Accommodation": [ + "$.accommodations[*].accommodationDescriptor" + ], + "RetestIndicator": [ + "$.retestIndicatorDescriptor" + ], + "ReasonNotTested": [ + "$.reasonNotTestedDescriptor" + ], + "WhenAssessedGradeLevel": [ + "$.whenAssessedGradeLevelDescriptor" + ], + "EventCircumstance": [ + "$.eventCircumstanceDescriptor" + ], + "EventDescription": [ + "$.eventDescription" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "PlatformType": [ + "$.platformTypeDescriptor" + ] + } + }, + "studentCompetencyObjectives": { + "resourceName": "StudentCompetencyObjective", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCompetencyObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific competency objective.", + "type": "object", + "properties": { + "competencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced competency objective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "competencyObjectiveReference", + "competencyLevelDescriptor", + "gradingPeriodReference", + "studentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCompetencyObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific competency objective.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "competencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced competency objective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "competencyObjectiveReference", + "competencyLevelDescriptor", + "gradingPeriodReference", + "studentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCompetencyObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific competency objective.", + "type": "object", + "properties": { + "competencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the CompetencyObjective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the CompetencyObjective is targeted." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced competency objective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.studentSectionAssociations[*].studentSectionAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + }, + { + "sourceJsonPath": "$.generalStudentProgramAssociations[*].generalStudentProgramAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "CompetencyObjective", + "GradingPeriod", + "Student" + ], + "documentPathsMapping": { + "CompetencyObjective": [ + "$.competencyObjectiveReference.educationOrganizationId", + "$.competencyObjectiveReference.objective", + "$.competencyObjectiveReference.objectiveGradeLevelDescriptor" + ], + "CompetencyLevel": [ + "$.competencyLevelDescriptor" + ], + "DiagnosticStatement": [ + "$.diagnosticStatement" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ] + } + }, + "studentGradebookEntries": { + "resourceName": "StudentGradebookEntry", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentGradebookEntry", + "description": "This entity holds a student's grade or competency level for a gradebook entry.", + "type": "object", + "properties": { + "dateFulfilled": { + "type": "string", + "format": "date", + "description": "The date an assignment was turned in or the date of an assessment." + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The CompetencyLevel assessed for the student for the referenced LearningObjective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradebookEntryReference": { + "type": "object", + "properties": { + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "gradebookEntryTitle": { + "type": "string", + "description": "The name or title of the activity to be recorded in the GradebookEntry.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "dateAssigned", + "gradebookEntryTitle", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference", + "gradebookEntryReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentGradebookEntry", + "description": "This entity holds a student's grade or competency level for a gradebook entry.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "dateFulfilled": { + "type": "string", + "format": "date", + "description": "The date an assignment was turned in or the date of an assessment." + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The CompetencyLevel assessed for the student for the referenced LearningObjective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradebookEntryReference": { + "type": "object", + "properties": { + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "gradebookEntryTitle": { + "type": "string", + "description": "The name or title of the activity to be recorded in the GradebookEntry.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "dateAssigned", + "gradebookEntryTitle", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentSectionAssociationReference", + "gradebookEntryReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentGradebookEntry", + "description": "This entity holds a student's grade or competency level for a gradebook entry.", + "type": "object", + "properties": { + "dateFulfilled": { + "type": "string", + "format": "date", + "description": "The date an assignment was turned in or the date of an assessment." + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The CompetencyLevel assessed for the student for the referenced LearningObjective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradebookEntryReference": { + "type": "object", + "properties": { + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "gradebookEntryTitle": { + "type": "string", + "description": "The name or title of the activity to be recorded in the GradebookEntry.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "dateAssigned", + "gradebookEntryTitle", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.gradebookEntryReference.localCourseCode", + "targetJsonPath": "$.studentSectionAssociationReference.localCourseCode" + }, + { + "sourceJsonPath": "$.gradebookEntryReference.schoolId", + "targetJsonPath": "$.studentSectionAssociationReference.schoolId" + }, + { + "sourceJsonPath": "$.gradebookEntryReference.schoolYear", + "targetJsonPath": "$.studentSectionAssociationReference.schoolYear" + }, + { + "sourceJsonPath": "$.gradebookEntryReference.sectionIdentifier", + "targetJsonPath": "$.studentSectionAssociationReference.sectionIdentifier" + }, + { + "sourceJsonPath": "$.gradebookEntryReference.sessionName", + "targetJsonPath": "$.studentSectionAssociationReference.sessionName" + } + ], + "identityFullnames": [ + "StudentSectionAssociation", + "GradebookEntry" + ], + "documentPathsMapping": { + "DateFulfilled": [ + "$.dateFulfilled" + ], + "LetterGradeEarned": [ + "$.letterGradeEarned" + ], + "NumericGradeEarned": [ + "$.numericGradeEarned" + ], + "CompetencyLevel": [ + "$.competencyLevelDescriptor" + ], + "DiagnosticStatement": [ + "$.diagnosticStatement" + ], + "StudentSectionAssociation": [ + "$.studentSectionAssociationReference.beginDate", + "$.studentSectionAssociationReference.localCourseCode", + "$.studentSectionAssociationReference.schoolId", + "$.studentSectionAssociationReference.schoolYear", + "$.studentSectionAssociationReference.sectionIdentifier", + "$.studentSectionAssociationReference.sessionName", + "$.studentSectionAssociationReference.studentUniqueId" + ], + "GradebookEntry": [ + "$.gradebookEntryReference.dateAssigned", + "$.gradebookEntryReference.gradebookEntryTitle", + "$.gradebookEntryReference.localCourseCode", + "$.gradebookEntryReference.schoolId", + "$.gradebookEntryReference.schoolYear", + "$.gradebookEntryReference.sectionIdentifier", + "$.gradebookEntryReference.sessionName" + ] + } + }, + "studentInterventionAttendanceEvents": { + "resourceName": "StudentInterventionAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentInterventionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for an intervention service.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "interventionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ] + }, + "interventionDuration": { + "type": "integer", + "description": "The duration in minutes in which the student participated in the intervention during this instance.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "interventionReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentInterventionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for an intervention service.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "interventionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ] + }, + "interventionDuration": { + "type": "integer", + "description": "The duration in minutes in which the student participated in the intervention during this instance.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "interventionReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentInterventionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for an intervention service.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "interventionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ] + }, + "interventionDuration": { + "type": "integer", + "description": "The duration in minutes in which the student participated in the intervention during this instance.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Student", + "Intervention" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Intervention": [ + "$.interventionReference.educationOrganizationId", + "$.interventionReference.interventionIdentificationCode" + ], + "InterventionDuration": [ + "$.interventionDuration" + ] + } + }, + "studentLearningObjectives": { + "resourceName": "StudentLearningObjective", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLearningObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific LearningObjective.", + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The CompetencyLevel assessed for the student for the referenced LearningObjective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveReference", + "competencyLevelDescriptor", + "gradingPeriodReference", + "studentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLearningObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific LearningObjective.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The CompetencyLevel assessed for the student for the referenced LearningObjective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "learningObjectiveReference", + "competencyLevelDescriptor", + "gradingPeriodReference", + "studentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLearningObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific LearningObjective.", + "type": "object", + "properties": { + "learningObjectiveReference": { + "type": "object", + "properties": { + "learningObjectiveId": { + "type": "string", + "description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the LearningObjective.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningObjectiveId", + "namespace" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The CompetencyLevel assessed for the student for the referenced LearningObjective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the Student's entry or assignment to the Section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.studentSectionAssociations[*].studentSectionAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + }, + { + "sourceJsonPath": "$.generalStudentProgramAssociations[*].generalStudentProgramAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "LearningObjective", + "GradingPeriod", + "Student" + ], + "documentPathsMapping": { + "LearningObjective": [ + "$.learningObjectiveReference.learningObjectiveId", + "$.learningObjectiveReference.namespace" + ], + "CompetencyLevel": [ + "$.competencyLevelDescriptor" + ], + "DiagnosticStatement": [ + "$.diagnosticStatement" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ] + } + }, + "studentProgramAttendanceEvents": { + "resourceName": "StudentProgramAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance to receive or participate in program services.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "programAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the program attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "educationOrganizationReference", + "programReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance to receive or participate in program services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "programAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the program attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "educationOrganizationReference", + "programReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance to receive or participate in program services.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "programAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the program attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Student", + "EducationOrganization", + "Program" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "ProgramAttendanceDuration": [ + "$.programAttendanceDuration" + ] + } + }, + "studentSchoolAttendanceEvents": { + "resourceName": "StudentSchoolAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a school day.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "schoolAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the school attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "schoolReference", + "sessionReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a school day.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "schoolAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the school attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "schoolReference", + "sessionReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a school day.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "schoolAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the school attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.sessionReference.schoolId", + "targetJsonPath": "$.schoolReference.schoolId" + } + ], + "identityFullnames": [ + "Student", + "School", + "Session" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "Session": [ + "$.sessionReference.schoolId", + "$.sessionReference.schoolYear", + "$.sessionReference.sessionName" + ], + "SchoolAttendanceDuration": [ + "$.schoolAttendanceDuration" + ], + "ArrivalTime": [ + "$.arrivalTime" + ], + "DepartureTime": [ + "$.departureTime" + ] + } + }, + "studentSectionAttendanceEvents": { + "resourceName": "StudentSectionAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSectionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a section.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "sectionAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the section attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "sectionReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSectionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a section.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "sectionAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the section attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "sectionReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSectionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a section.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "sectionAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the section attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.classPeriods[*].classPeriodReference.schoolId", + "targetJsonPath": "$.sectionReference.schoolId" + } + ], + "identityFullnames": [ + "Student", + "Section" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Section": [ + "$.sectionReference.localCourseCode", + "$.sectionReference.schoolId", + "$.sectionReference.schoolYear", + "$.sectionReference.sectionIdentifier", + "$.sectionReference.sessionName" + ], + "SectionAttendanceDuration": [ + "$.sectionAttendanceDuration" + ], + "ArrivalTime": [ + "$.arrivalTime" + ], + "DepartureTime": [ + "$.departureTime" + ], + "ClassPeriod": [ + "$.classPeriods[*].classPeriodReference.classPeriodName", + "$.classPeriods[*].classPeriodReference.schoolId" + ] + } + }, + "surveys": { + "resourceName": "Survey", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Survey", + "description": "A survey to identified or anonymous respondents.", + "type": "object", + "properties": { + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "surveyTitle": { + "type": "string", + "description": "The title of the survey.", + "minLength": 1, + "maxLength": 255 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "surveyCategoryDescriptor": { + "type": "string", + "description": "The category or type of survey." + }, + "numberAdministered": { + "type": "integer", + "description": "Number of persons to whom this survey was administered." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyIdentifier", + "namespace", + "surveyTitle", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Survey", + "description": "A survey to identified or anonymous respondents.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "surveyTitle": { + "type": "string", + "description": "The title of the survey.", + "minLength": 1, + "maxLength": 255 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "surveyCategoryDescriptor": { + "type": "string", + "description": "The category or type of survey." + }, + "numberAdministered": { + "type": "integer", + "description": "Number of persons to whom this survey was administered." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyIdentifier", + "namespace", + "surveyTitle", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Survey", + "description": "A survey to identified or anonymous respondents.", + "type": "object", + "properties": { + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "surveyTitle": { + "type": "string", + "description": "The title of the survey.", + "minLength": 1, + "maxLength": 255 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "surveyCategoryDescriptor": { + "type": "string", + "description": "The category or type of survey." + }, + "numberAdministered": { + "type": "integer", + "description": "Number of persons to whom this survey was administered." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "SurveyIdentifier", + "Namespace" + ], + "documentPathsMapping": { + "SurveyIdentifier": [ + "$.surveyIdentifier" + ], + "Namespace": [ + "$.namespace" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "SurveyTitle": [ + "$.surveyTitle" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "Session": [ + "$.sessionReference.schoolId", + "$.sessionReference.schoolYear", + "$.sessionReference.sessionName" + ], + "SurveyCategory": [ + "$.surveyCategoryDescriptor" + ], + "NumberAdministered": [ + "$.numberAdministered" + ] + } + }, + "surveyQuestions": { + "resourceName": "SurveyQuestion", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestion", + "description": "The questions for the survey.", + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "questionFormDescriptor": { + "type": "string", + "description": "The form or type of question." + }, + "questionText": { + "type": "string", + "description": "The text of the question.", + "minLength": 1, + "maxLength": 1024 + }, + "responseChoices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sortOrder": { + "type": "integer", + "description": "Sort order of this ResponseChoice within the complete list of choices attached to a SurveyQuestion. If sort order doesn't apply, the value of NumericValue or a unique, possibly sequential numeric value." + }, + "numericValue": { + "type": "integer", + "description": "A valid numeric response. If paired with a TextValue, the numeric equivalent of the TextValue.", + "minimum": 0, + "maximum": 100 + }, + "textValue": { + "type": "string", + "description": "A valid text response. If paired with a NumericValue, the text equivalent of the NumericValue.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "sortOrder" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "matrices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "minRawScore": { + "type": "integer", + "description": "The minimum score possible on a survey." + }, + "maxRawScore": { + "type": "integer", + "description": "The maximum score possible on a survey." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "surveyReference", + "questionFormDescriptor", + "questionText" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestion", + "description": "The questions for the survey.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "questionFormDescriptor": { + "type": "string", + "description": "The form or type of question." + }, + "questionText": { + "type": "string", + "description": "The text of the question.", + "minLength": 1, + "maxLength": 1024 + }, + "responseChoices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sortOrder": { + "type": "integer", + "description": "Sort order of this ResponseChoice within the complete list of choices attached to a SurveyQuestion. If sort order doesn't apply, the value of NumericValue or a unique, possibly sequential numeric value." + }, + "numericValue": { + "type": "integer", + "description": "A valid numeric response. If paired with a TextValue, the numeric equivalent of the TextValue.", + "minimum": 0, + "maximum": 100 + }, + "textValue": { + "type": "string", + "description": "A valid text response. If paired with a NumericValue, the text equivalent of the NumericValue.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "sortOrder" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "matrices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "minRawScore": { + "type": "integer", + "description": "The minimum score possible on a survey." + }, + "maxRawScore": { + "type": "integer", + "description": "The maximum score possible on a survey." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "questionCode", + "surveyReference", + "questionFormDescriptor", + "questionText" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestion", + "description": "The questions for the survey.", + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "questionFormDescriptor": { + "type": "string", + "description": "The form or type of question." + }, + "questionText": { + "type": "string", + "description": "The text of the question.", + "minLength": 1, + "maxLength": 1024 + }, + "responseChoices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sortOrder": { + "type": "integer", + "description": "Sort order of this ResponseChoice within the complete list of choices attached to a SurveyQuestion. If sort order doesn't apply, the value of NumericValue or a unique, possibly sequential numeric value." + }, + "numericValue": { + "type": "integer", + "description": "A valid numeric response. If paired with a TextValue, the numeric equivalent of the TextValue.", + "minimum": 0, + "maximum": 100 + }, + "textValue": { + "type": "string", + "description": "A valid text response. If paired with a NumericValue, the text equivalent of the NumericValue.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "sortOrder" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "matrices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "minRawScore": { + "type": "integer", + "description": "The minimum score possible on a survey." + }, + "maxRawScore": { + "type": "integer", + "description": "The maximum score possible on a survey." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.surveySectionReference.namespace", + "targetJsonPath": "$.surveyReference.namespace" + }, + { + "sourceJsonPath": "$.surveySectionReference.surveyIdentifier", + "targetJsonPath": "$.surveyReference.surveyIdentifier" + } + ], + "identityFullnames": [ + "QuestionCode", + "Survey" + ], + "documentPathsMapping": { + "QuestionCode": [ + "$.questionCode" + ], + "Survey": [ + "$.surveyReference.namespace", + "$.surveyReference.surveyIdentifier" + ], + "QuestionForm": [ + "$.questionFormDescriptor" + ], + "QuestionText": [ + "$.questionText" + ], + "SurveySection": [ + "$.surveySectionReference.namespace", + "$.surveySectionReference.surveyIdentifier", + "$.surveySectionReference.surveySectionTitle" + ] + } + }, + "surveyQuestionResponses": { + "resourceName": "SurveyQuestionResponse", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestionResponse", + "description": "The response to a survey question.", + "type": "object", + "properties": { + "surveyQuestionReference": { + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "namespace", + "surveyIdentifier" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyQuestionResponseValueIdentifier": { + "type": "integer", + "description": "Primary key for the response value; a unique, usually sequential numeric value for a collection of responses, or potentially the value of NumericResponse for a single response." + }, + "numericResponse": { + "type": "integer", + "description": "A numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "A text response to the question.", + "minLength": 1, + "maxLength": 2048 + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionResponseValueIdentifier" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveyQuestionMatrixElementResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "numericResponse": { + "type": "integer", + "description": "The numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "The text response(s) for the question.", + "minLength": 1, + "maxLength": 2048 + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "minNumericResponse": { + "type": "integer", + "description": "The minimum score response to the question." + }, + "maxNumericResponse": { + "type": "integer", + "description": "The maximum score response to the question." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "comment": { + "type": "string", + "description": "Additional information provided by the responder about the question in the survey.", + "minLength": 1, + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestionResponse", + "description": "The response to a survey question.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyQuestionReference": { + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "namespace", + "surveyIdentifier" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyQuestionResponseValueIdentifier": { + "type": "integer", + "description": "Primary key for the response value; a unique, usually sequential numeric value for a collection of responses, or potentially the value of NumericResponse for a single response." + }, + "numericResponse": { + "type": "integer", + "description": "A numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "A text response to the question.", + "minLength": 1, + "maxLength": 2048 + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionResponseValueIdentifier" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveyQuestionMatrixElementResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "numericResponse": { + "type": "integer", + "description": "The numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "The text response(s) for the question.", + "minLength": 1, + "maxLength": 2048 + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "minNumericResponse": { + "type": "integer", + "description": "The minimum score response to the question." + }, + "maxNumericResponse": { + "type": "integer", + "description": "The maximum score response to the question." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "comment": { + "type": "string", + "description": "Additional information provided by the responder about the question in the survey.", + "minLength": 1, + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyQuestionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestionResponse", + "description": "The response to a survey question.", + "type": "object", + "properties": { + "surveyQuestionReference": { + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "namespace", + "surveyIdentifier" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyQuestionResponseValueIdentifier": { + "type": "integer", + "description": "Primary key for the response value; a unique, usually sequential numeric value for a collection of responses, or potentially the value of NumericResponse for a single response." + }, + "numericResponse": { + "type": "integer", + "description": "A numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "A text response to the question.", + "minLength": 1, + "maxLength": 2048 + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionResponseValueIdentifier" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveyQuestionMatrixElementResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "numericResponse": { + "type": "integer", + "description": "The numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "The text response(s) for the question.", + "minLength": 1, + "maxLength": 2048 + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "minNumericResponse": { + "type": "integer", + "description": "The minimum score response to the question." + }, + "maxNumericResponse": { + "type": "integer", + "description": "The maximum score response to the question." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "comment": { + "type": "string", + "description": "Additional information provided by the responder about the question in the survey.", + "minLength": 1, + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.surveyResponseReference.namespace", + "targetJsonPath": "$.surveyQuestionReference.namespace" + }, + { + "sourceJsonPath": "$.surveyResponseReference.surveyIdentifier", + "targetJsonPath": "$.surveyQuestionReference.surveyIdentifier" + } + ], + "identityFullnames": [ + "SurveyQuestion", + "SurveyResponse" + ], + "documentPathsMapping": { + "SurveyQuestion": [ + "$.surveyQuestionReference.namespace", + "$.surveyQuestionReference.questionCode", + "$.surveyQuestionReference.surveyIdentifier" + ], + "SurveyResponse": [ + "$.surveyResponseReference.namespace", + "$.surveyResponseReference.surveyIdentifier", + "$.surveyResponseReference.surveyResponseIdentifier" + ], + "NoResponse": [ + "$.noResponse" + ], + "Comment": [ + "$.comment" + ] + } + }, + "surveyResponses": { + "resourceName": "SurveyResponse", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyResponse", + "description": "Responses to a Survey for named or anonymous persons.", + "type": "object", + "properties": { + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "responseDate": { + "type": "string", + "format": "date", + "description": "Date of the survey response." + }, + "responseTime": { + "type": "integer", + "description": "The amount of time (in seconds) it took for the respondent to complete the survey." + }, + "surveyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "surveyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMailAddress": { + "type": "string", + "description": "Email address of the respondent.", + "minLength": 7, + "maxLength": 128 + }, + "fullName": { + "type": "string", + "description": "Full name of the respondent.", + "maxLength": 80 + }, + "location": { + "type": "string", + "description": "Location of the respondent, often a city, district, or school.", + "minLength": 1, + "maxLength": 75 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "parentReference": { + "type": "object", + "properties": { + "parentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a parent.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyResponseIdentifier", + "surveyReference", + "responseDate" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyResponse", + "description": "Responses to a Survey for named or anonymous persons.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "responseDate": { + "type": "string", + "format": "date", + "description": "Date of the survey response." + }, + "responseTime": { + "type": "integer", + "description": "The amount of time (in seconds) it took for the respondent to complete the survey." + }, + "surveyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "surveyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMailAddress": { + "type": "string", + "description": "Email address of the respondent.", + "minLength": 7, + "maxLength": 128 + }, + "fullName": { + "type": "string", + "description": "Full name of the respondent.", + "maxLength": 80 + }, + "location": { + "type": "string", + "description": "Location of the respondent, often a city, district, or school.", + "minLength": 1, + "maxLength": 75 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "parentReference": { + "type": "object", + "properties": { + "parentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a parent.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyResponseIdentifier", + "surveyReference", + "responseDate" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyResponse", + "description": "Responses to a Survey for named or anonymous persons.", + "type": "object", + "properties": { + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "responseDate": { + "type": "string", + "format": "date", + "description": "Date of the survey response." + }, + "responseTime": { + "type": "integer", + "description": "The amount of time (in seconds) it took for the respondent to complete the survey." + }, + "surveyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "surveyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMailAddress": { + "type": "string", + "description": "Email address of the respondent.", + "minLength": 7, + "maxLength": 128 + }, + "fullName": { + "type": "string", + "description": "Full name of the respondent.", + "maxLength": 80 + }, + "location": { + "type": "string", + "description": "Location of the respondent, often a city, district, or school.", + "minLength": 1, + "maxLength": 75 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "parentReference": { + "type": "object", + "properties": { + "parentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a parent.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "SurveyResponseIdentifier", + "Survey" + ], + "documentPathsMapping": { + "SurveyResponseIdentifier": [ + "$.surveyResponseIdentifier" + ], + "Survey": [ + "$.surveyReference.namespace", + "$.surveyReference.surveyIdentifier" + ], + "ResponseDate": [ + "$.responseDate" + ], + "ResponseTime": [ + "$.responseTime" + ], + "SurveyLevel": [ + "$.surveyLevels[*].surveyLevelDescriptor" + ], + "ElectronicMailAddress": [ + "$.electronicMailAddress" + ], + "FullName": [ + "$.fullName" + ], + "Location": [ + "$.location" + ] + } + }, + "surveySections": { + "resourceName": "SurveySection", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySection", + "description": "The section of questions for the survey.", + "type": "object", + "properties": { + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyReference", + "surveySectionTitle" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySection", + "description": "The section of questions for the survey.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyReference", + "surveySectionTitle" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySection", + "description": "The section of questions for the survey.", + "type": "object", + "properties": { + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Survey", + "SurveySectionTitle" + ], + "documentPathsMapping": { + "Survey": [ + "$.surveyReference.namespace", + "$.surveyReference.surveyIdentifier" + ], + "SurveySectionTitle": [ + "$.surveySectionTitle" + ] + } + }, + "surveySectionResponses": { + "resourceName": "SurveySectionResponse", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySectionResponse", + "description": "Optional information about the responses provided for a section of a survey.", + "type": "object", + "properties": { + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "sectionRating": { + "type": "number", + "description": "Numeric rating computed from the survey responses for the section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveySectionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySectionResponse", + "description": "Optional information about the responses provided for a section of a survey.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "sectionRating": { + "type": "number", + "description": "Numeric rating computed from the survey responses for the section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveySectionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySectionResponse", + "description": "Optional information about the responses provided for a section of a survey.", + "type": "object", + "properties": { + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the Survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "sectionRating": { + "type": "number", + "description": "Numeric rating computed from the survey responses for the section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.surveyResponseReference.namespace", + "targetJsonPath": "$.surveySectionReference.namespace" + }, + { + "sourceJsonPath": "$.surveyResponseReference.surveyIdentifier", + "targetJsonPath": "$.surveySectionReference.surveyIdentifier" + } + ], + "identityFullnames": [ + "SurveySection", + "SurveyResponse" + ], + "documentPathsMapping": { + "SurveySection": [ + "$.surveySectionReference.namespace", + "$.surveySectionReference.surveyIdentifier", + "$.surveySectionReference.surveySectionTitle" + ], + "SurveyResponse": [ + "$.surveyResponseReference.namespace", + "$.surveyResponseReference.surveyIdentifier", + "$.surveyResponseReference.surveyResponseIdentifier" + ], + "SectionRating": [ + "$.sectionRating" + ] + } + }, + "generalStudentProgramAssociations": { + "resourceName": "GeneralStudentProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GeneralStudentProgramAssociation", + "description": "This association base class represents the basic relationship between students and programs.", + "type": "object", + "properties": { + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GeneralStudentProgramAssociation", + "description": "This association base class represents the basic relationship between students and programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GeneralStudentProgramAssociation", + "description": "This association base class represents the basic relationship between students and programs.", + "type": "object", + "properties": { + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Student", + "Program", + "BeginDate", + "EducationOrganization" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "communityOrganizations": { + "resourceName": "CommunityOrganization", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityOrganization", + "description": "This entity represents an administrative unit at the state level which exists primarily to operate local community providers.", + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a CommunityOrganization." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityOrganization", + "description": "This entity represents an administrative unit at the state level which exists primarily to operate local community providers.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a CommunityOrganization." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "communityOrganizationId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityOrganization", + "description": "This entity represents an administrative unit at the state level which exists primarily to operate local community providers.", + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a CommunityOrganization." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CommunityOrganizationId" + ], + "documentPathsMapping": { + "CommunityOrganizationId": [ + "$.communityOrganizationId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "communityProviders": { + "resourceName": "CommunityProvider", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProvider", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a CommunityProvider." + }, + "communityOrganizationReference": { + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a CommunityOrganization." + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId" + ] + }, + "providerProfitabilityDescriptor": { + "type": "string", + "description": "Indicates the profitability status of the provider." + }, + "providerStatusDescriptor": { + "type": "string", + "description": "Indicates the status of the provider." + }, + "providerCategoryDescriptor": { + "type": "string", + "description": "Indicates the category of the provider." + }, + "schoolIndicator": { + "type": "boolean", + "description": "An indication of whether the community provider is a school." + }, + "licenseExemptIndicator": { + "type": "boolean", + "description": "An indication of whether the provider is exempt from having a license." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId", + "providerStatusDescriptor", + "providerCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProvider", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a CommunityProvider." + }, + "communityOrganizationReference": { + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a CommunityOrganization." + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId" + ] + }, + "providerProfitabilityDescriptor": { + "type": "string", + "description": "Indicates the profitability status of the provider." + }, + "providerStatusDescriptor": { + "type": "string", + "description": "Indicates the status of the provider." + }, + "providerCategoryDescriptor": { + "type": "string", + "description": "Indicates the category of the provider." + }, + "schoolIndicator": { + "type": "boolean", + "description": "An indication of whether the community provider is a school." + }, + "licenseExemptIndicator": { + "type": "boolean", + "description": "An indication of whether the provider is exempt from having a license." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "communityProviderId", + "providerStatusDescriptor", + "providerCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProvider", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a CommunityProvider." + }, + "communityOrganizationReference": { + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a CommunityOrganization." + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId" + ] + }, + "providerProfitabilityDescriptor": { + "type": "string", + "description": "Indicates the profitability status of the provider." + }, + "providerStatusDescriptor": { + "type": "string", + "description": "Indicates the status of the provider." + }, + "providerCategoryDescriptor": { + "type": "string", + "description": "Indicates the category of the provider." + }, + "schoolIndicator": { + "type": "boolean", + "description": "An indication of whether the community provider is a school." + }, + "licenseExemptIndicator": { + "type": "boolean", + "description": "An indication of whether the provider is exempt from having a license." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CommunityProviderId" + ], + "documentPathsMapping": { + "CommunityProviderId": [ + "$.communityProviderId" + ], + "CommunityOrganization": [ + "$.communityOrganizationReference.communityOrganizationId" + ], + "ProviderProfitability": [ + "$.providerProfitabilityDescriptor" + ], + "ProviderStatus": [ + "$.providerStatusDescriptor" + ], + "ProviderCategory": [ + "$.providerCategoryDescriptor" + ], + "SchoolIndicator": [ + "$.schoolIndicator" + ], + "LicenseExemptIndicator": [ + "$.licenseExemptIndicator" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "educationOrganizationNetworks": { + "resourceName": "EducationOrganizationNetwork", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationOrganizationNetwork", + "description": "This entity is a self-organized membership network of peer-level education organizations intended to provide shared services or collective procurement.", + "type": "object", + "properties": { + "educationOrganizationNetworkId": { + "type": "integer", + "description": "The identifier assigned to a network of education organizations." + }, + "networkPurposeDescriptor": { + "type": "string", + "description": "The purpose(s) of the network (e.g., shared services, collective procurement)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationNetworkId", + "networkPurposeDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationOrganizationNetwork", + "description": "This entity is a self-organized membership network of peer-level education organizations intended to provide shared services or collective procurement.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationOrganizationNetworkId": { + "type": "integer", + "description": "The identifier assigned to a network of education organizations." + }, + "networkPurposeDescriptor": { + "type": "string", + "description": "The purpose(s) of the network (e.g., shared services, collective procurement)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationOrganizationNetworkId", + "networkPurposeDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationOrganizationNetwork", + "description": "This entity is a self-organized membership network of peer-level education organizations intended to provide shared services or collective procurement.", + "type": "object", + "properties": { + "educationOrganizationNetworkId": { + "type": "integer", + "description": "The identifier assigned to a network of education organizations." + }, + "networkPurposeDescriptor": { + "type": "string", + "description": "The purpose(s) of the network (e.g., shared services, collective procurement)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganizationNetworkId" + ], + "documentPathsMapping": { + "EducationOrganizationNetworkId": [ + "$.educationOrganizationNetworkId" + ], + "NetworkPurpose": [ + "$.networkPurposeDescriptor" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "educationServiceCenters": { + "resourceName": "EducationServiceCenter", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationServiceCenter", + "description": "This entity represents a regional, multi-services public agency authorized by state law to develop, manage and provide services, programs, or other support options (e.g., construction, food services, and technology services) to LEAs.", + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationServiceCenter", + "description": "This entity represents a regional, multi-services public agency authorized by state law to develop, manage and provide services, programs, or other support options (e.g., construction, food services, and technology services) to LEAs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationServiceCenterId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationServiceCenter", + "description": "This entity represents a regional, multi-services public agency authorized by state law to develop, manage and provide services, programs, or other support options (e.g., construction, food services, and technology services) to LEAs.", + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationServiceCenterId" + ], + "documentPathsMapping": { + "EducationServiceCenterId": [ + "$.educationServiceCenterId" + ], + "StateEducationAgency": [ + "$.stateEducationAgencyReference.stateEducationAgencyId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "localEducationAgencies": { + "resourceName": "LocalEducationAgency", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEducationAgency", + "description": "This entity represents an administrative unit at the local level which exists primarily to operate schools or to contract for educational services. It includes school districts, charter schools, charter management organizations, or other local administrative organizations.", + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + }, + "localEducationAgencyCategoryDescriptor": { + "type": "string", + "description": "The category of local education agency/district. For example: Independent or Charter." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "gunFreeSchoolsActReportingStatusDescriptor": { + "type": "string", + "description": "An indication of whether the school or Local Education Agency (LEA) submitted a Gun-Free Schools Act (GFSA) of 1994 report to the state, as defined by Title 18, Section 921." + }, + "schoolChoiceImplementStatusDescriptor": { + "type": "string", + "description": "An indication of whether the LEA was able to implement the provisions for public school choice under Title I, Part A, Section 1116 of ESEA as amended." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "innovativeDollarsSpent": { + "type": "number", + "description": "The total Title V, Part A funds expended by LEAs." + }, + "innovativeDollarsSpentStrategicPriorities": { + "type": "number", + "description": "The total amount of Title V, Part A funds expended by LEAs for the four strategic priorities." + }, + "innovativeProgramsFundsReceived": { + "type": "number", + "description": "The total Title V, Part A funds received by LEAs." + }, + "schoolImprovementAllocation": { + "type": "number", + "description": "The amount of Section 1003(a) and 1003(g) allocations to LEAs." + }, + "schoolImprovementReservedFundsPercentage": { + "type": "number", + "description": "An indication of the percentage of the Title I, Part A allocation that the SEA reserved in accordance with Section 1003(a) of ESEA and 200.100(a) of ED's regulations governing the reservation of funds for school improvement under Section 1003(a) of ESEA." + }, + "supplementalEducationalServicesFundsSpent": { + "type": "number", + "description": "The dollar amount spent on supplemental educational services during the school year under Title I, Part A, Section 1116 of ESEA as amended." + }, + "supplementalEducationalServicesPerPupilExpenditure": { + "type": "number", + "description": "The maximum dollar amount that may be spent per child for expenditures related to supplemental educational services under Title I of the ESEA." + }, + "stateAssessmentAdministrationFunding": { + "type": "number", + "description": "The percentage of funds used to administer assessments required by Section 1111(b) or to carry out other activities described in Section 6111 and other activities related to ensuring that the state's schools and LEAs are held accountable for results." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLocalEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "educationServiceCenterReference": { + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId" + ] + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId", + "localEducationAgencyCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEducationAgency", + "description": "This entity represents an administrative unit at the local level which exists primarily to operate schools or to contract for educational services. It includes school districts, charter schools, charter management organizations, or other local administrative organizations.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + }, + "localEducationAgencyCategoryDescriptor": { + "type": "string", + "description": "The category of local education agency/district. For example: Independent or Charter." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "gunFreeSchoolsActReportingStatusDescriptor": { + "type": "string", + "description": "An indication of whether the school or Local Education Agency (LEA) submitted a Gun-Free Schools Act (GFSA) of 1994 report to the state, as defined by Title 18, Section 921." + }, + "schoolChoiceImplementStatusDescriptor": { + "type": "string", + "description": "An indication of whether the LEA was able to implement the provisions for public school choice under Title I, Part A, Section 1116 of ESEA as amended." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "innovativeDollarsSpent": { + "type": "number", + "description": "The total Title V, Part A funds expended by LEAs." + }, + "innovativeDollarsSpentStrategicPriorities": { + "type": "number", + "description": "The total amount of Title V, Part A funds expended by LEAs for the four strategic priorities." + }, + "innovativeProgramsFundsReceived": { + "type": "number", + "description": "The total Title V, Part A funds received by LEAs." + }, + "schoolImprovementAllocation": { + "type": "number", + "description": "The amount of Section 1003(a) and 1003(g) allocations to LEAs." + }, + "schoolImprovementReservedFundsPercentage": { + "type": "number", + "description": "An indication of the percentage of the Title I, Part A allocation that the SEA reserved in accordance with Section 1003(a) of ESEA and 200.100(a) of ED's regulations governing the reservation of funds for school improvement under Section 1003(a) of ESEA." + }, + "supplementalEducationalServicesFundsSpent": { + "type": "number", + "description": "The dollar amount spent on supplemental educational services during the school year under Title I, Part A, Section 1116 of ESEA as amended." + }, + "supplementalEducationalServicesPerPupilExpenditure": { + "type": "number", + "description": "The maximum dollar amount that may be spent per child for expenditures related to supplemental educational services under Title I of the ESEA." + }, + "stateAssessmentAdministrationFunding": { + "type": "number", + "description": "The percentage of funds used to administer assessments required by Section 1111(b) or to carry out other activities described in Section 6111 and other activities related to ensuring that the state's schools and LEAs are held accountable for results." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLocalEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "educationServiceCenterReference": { + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId" + ] + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "localEducationAgencyId", + "localEducationAgencyCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEducationAgency", + "description": "This entity represents an administrative unit at the local level which exists primarily to operate schools or to contract for educational services. It includes school districts, charter schools, charter management organizations, or other local administrative organizations.", + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + }, + "localEducationAgencyCategoryDescriptor": { + "type": "string", + "description": "The category of local education agency/district. For example: Independent or Charter." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "gunFreeSchoolsActReportingStatusDescriptor": { + "type": "string", + "description": "An indication of whether the school or Local Education Agency (LEA) submitted a Gun-Free Schools Act (GFSA) of 1994 report to the state, as defined by Title 18, Section 921." + }, + "schoolChoiceImplementStatusDescriptor": { + "type": "string", + "description": "An indication of whether the LEA was able to implement the provisions for public school choice under Title I, Part A, Section 1116 of ESEA as amended." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "innovativeDollarsSpent": { + "type": "number", + "description": "The total Title V, Part A funds expended by LEAs." + }, + "innovativeDollarsSpentStrategicPriorities": { + "type": "number", + "description": "The total amount of Title V, Part A funds expended by LEAs for the four strategic priorities." + }, + "innovativeProgramsFundsReceived": { + "type": "number", + "description": "The total Title V, Part A funds received by LEAs." + }, + "schoolImprovementAllocation": { + "type": "number", + "description": "The amount of Section 1003(a) and 1003(g) allocations to LEAs." + }, + "schoolImprovementReservedFundsPercentage": { + "type": "number", + "description": "An indication of the percentage of the Title I, Part A allocation that the SEA reserved in accordance with Section 1003(a) of ESEA and 200.100(a) of ED's regulations governing the reservation of funds for school improvement under Section 1003(a) of ESEA." + }, + "supplementalEducationalServicesFundsSpent": { + "type": "number", + "description": "The dollar amount spent on supplemental educational services during the school year under Title I, Part A, Section 1116 of ESEA as amended." + }, + "supplementalEducationalServicesPerPupilExpenditure": { + "type": "number", + "description": "The maximum dollar amount that may be spent per child for expenditures related to supplemental educational services under Title I of the ESEA." + }, + "stateAssessmentAdministrationFunding": { + "type": "number", + "description": "The percentage of funds used to administer assessments required by Section 1111(b) or to carry out other activities described in Section 6111 and other activities related to ensuring that the state's schools and LEAs are held accountable for results." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLocalEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "educationServiceCenterReference": { + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId" + ] + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LocalEducationAgencyId" + ], + "documentPathsMapping": { + "LocalEducationAgencyId": [ + "$.localEducationAgencyId" + ], + "LocalEducationAgencyCategory": [ + "$.localEducationAgencyCategoryDescriptor" + ], + "CharterStatus": [ + "$.charterStatusDescriptor" + ], + "ParentLocalEducationAgency": [ + "$.parentLocalEducationAgencyReference.localEducationAgencyId" + ], + "EducationServiceCenter": [ + "$.educationServiceCenterReference.educationServiceCenterId" + ], + "StateEducationAgency": [ + "$.stateEducationAgencyReference.stateEducationAgencyId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "organizationDepartments": { + "resourceName": "OrganizationDepartment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OrganizationDepartment", + "description": "An organizational unit of another education organization, often devoted to a particular academic discipline, area of study, or organization function.", + "type": "object", + "properties": { + "organizationDepartmentId": { + "type": "integer", + "description": "The unique identification code for the OrganizationDepartment." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the department." + }, + "parentEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "organizationDepartmentId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OrganizationDepartment", + "description": "An organizational unit of another education organization, often devoted to a particular academic discipline, area of study, or organization function.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "organizationDepartmentId": { + "type": "integer", + "description": "The unique identification code for the OrganizationDepartment." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the department." + }, + "parentEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "organizationDepartmentId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OrganizationDepartment", + "description": "An organizational unit of another education organization, often devoted to a particular academic discipline, area of study, or organization function.", + "type": "object", + "properties": { + "organizationDepartmentId": { + "type": "integer", + "description": "The unique identification code for the OrganizationDepartment." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the department." + }, + "parentEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "OrganizationDepartmentId" + ], + "documentPathsMapping": { + "OrganizationDepartmentId": [ + "$.organizationDepartmentId" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ], + "ParentEducationOrganization": [ + "$.parentEducationOrganizationReference.educationOrganizationId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "postSecondaryInstitutions": { + "resourceName": "PostSecondaryInstitution", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryInstitution", + "description": "An organization that provides educational programs for individuals who have completed or otherwise left educational programs in secondary school(s).", + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + }, + "mediumOfInstructions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "mediumOfInstructionDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "postSecondaryInstitutionLevelDescriptor": { + "type": "string", + "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryInstitution", + "description": "An organization that provides educational programs for individuals who have completed or otherwise left educational programs in secondary school(s).", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + }, + "mediumOfInstructions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "mediumOfInstructionDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "postSecondaryInstitutionLevelDescriptor": { + "type": "string", + "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "postSecondaryInstitutionId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryInstitution", + "description": "An organization that provides educational programs for individuals who have completed or otherwise left educational programs in secondary school(s).", + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + }, + "mediumOfInstructions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "mediumOfInstructionDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "postSecondaryInstitutionLevelDescriptor": { + "type": "string", + "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "PostSecondaryInstitutionId" + ], + "documentPathsMapping": { + "PostSecondaryInstitutionId": [ + "$.postSecondaryInstitutionId" + ], + "MediumOfInstruction": [ + "$.mediumOfInstructions[*].mediumOfInstructionDescriptor" + ], + "PostSecondaryInstitutionLevel": [ + "$.postSecondaryInstitutionLevelDescriptor" + ], + "AdministrativeFundingControl": [ + "$.administrativeFundingControlDescriptor" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "schools": { + "resourceName": "School", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.School", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "schoolCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "schoolCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolTypeDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its primary focus." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "titleIPartASchoolDesignationDescriptor": { + "type": "string", + "description": "Denotes the Title I Part A designation for the school." + }, + "magnetSpecialProgramEmphasisSchoolDescriptor": { + "type": "string", + "description": "A school that has been designed: 1) to attract students of different racial/ethnic backgrounds for the purpose of reducing, preventing, or eliminating racial isolation; and/or 2) to provide an academic or social focus on a particular theme (e.g., science/math, performing arts, gifted/talented, or foreign language)." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its funding source, for example public or private." + }, + "internetAccessDescriptor": { + "type": "string", + "description": "The type of Internet access available." + }, + "localEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "charterApprovalAgencyTypeDescriptor": { + "type": "string", + "description": "The type of agency that approved the establishment or continuation of a charter school." + }, + "charterApprovalSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "educationOrganizationCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "gradeLevels", + "nameOfInstitution", + "educationOrganizationCategories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.School", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "schoolCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "schoolCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolTypeDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its primary focus." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "titleIPartASchoolDesignationDescriptor": { + "type": "string", + "description": "Denotes the Title I Part A designation for the school." + }, + "magnetSpecialProgramEmphasisSchoolDescriptor": { + "type": "string", + "description": "A school that has been designed: 1) to attract students of different racial/ethnic backgrounds for the purpose of reducing, preventing, or eliminating racial isolation; and/or 2) to provide an academic or social focus on a particular theme (e.g., science/math, performing arts, gifted/talented, or foreign language)." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its funding source, for example public or private." + }, + "internetAccessDescriptor": { + "type": "string", + "description": "The type of Internet access available." + }, + "localEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "charterApprovalAgencyTypeDescriptor": { + "type": "string", + "description": "The type of agency that approved the establishment or continuation of a charter school." + }, + "charterApprovalSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "educationOrganizationCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolId", + "gradeLevels", + "nameOfInstitution", + "educationOrganizationCategories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.School", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "schoolCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "schoolCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolTypeDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its primary focus." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "titleIPartASchoolDesignationDescriptor": { + "type": "string", + "description": "Denotes the Title I Part A designation for the school." + }, + "magnetSpecialProgramEmphasisSchoolDescriptor": { + "type": "string", + "description": "A school that has been designed: 1) to attract students of different racial/ethnic backgrounds for the purpose of reducing, preventing, or eliminating racial isolation; and/or 2) to provide an academic or social focus on a particular theme (e.g., science/math, performing arts, gifted/talented, or foreign language)." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its funding source, for example public or private." + }, + "internetAccessDescriptor": { + "type": "string", + "description": "The type of Internet access available." + }, + "localEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "charterApprovalAgencyTypeDescriptor": { + "type": "string", + "description": "The type of agency that approved the establishment or continuation of a charter school." + }, + "charterApprovalSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "educationOrganizationCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "SchoolId" + ], + "documentPathsMapping": { + "SchoolId": [ + "$.schoolId" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "SchoolCategory": [ + "$.schoolCategories[*].schoolCategoryDescriptor" + ], + "SchoolType": [ + "$.schoolTypeDescriptor" + ], + "CharterStatus": [ + "$.charterStatusDescriptor" + ], + "TitleIPartASchoolDesignation": [ + "$.titleIPartASchoolDesignationDescriptor" + ], + "MagnetSpecialProgramEmphasisSchool": [ + "$.magnetSpecialProgramEmphasisSchoolDescriptor" + ], + "AdministrativeFundingControl": [ + "$.administrativeFundingControlDescriptor" + ], + "InternetAccess": [ + "$.internetAccessDescriptor" + ], + "LocalEducationAgency": [ + "$.localEducationAgencyReference.localEducationAgencyId" + ], + "CharterApprovalAgencyType": [ + "$.charterApprovalAgencyTypeDescriptor" + ], + "CharterApprovalSchoolYear": [ + "$.charterApprovalSchoolYearTypeReference.schoolYear" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.educationOrganizationCategories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "stateEducationAgencies": { + "resourceName": "StateEducationAgency", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StateEducationAgency", + "description": "This entity represents the agency of the state charged with the primary responsibility for coordinating and supervising public instruction, including the setting of standards for elementary and secondary instructional programs.", + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "cteGraduationRateInclusion": { + "type": "boolean", + "description": "An indication of whether CTE concentrators are included in the state's computation of its graduation rate." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "federalProgramsFundingAllocation": { + "type": "number", + "description": "The amount of federal dollars distributed to Local Education Agencies (LEAs), retained by the State Education Agency (SEA) for program administration or other approved state-level activities (including unallocated, transferred to another state agency, or distributed to entities other than LEAs)." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StateEducationAgency", + "description": "This entity represents the agency of the state charged with the primary responsibility for coordinating and supervising public instruction, including the setting of standards for elementary and secondary instructional programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "cteGraduationRateInclusion": { + "type": "boolean", + "description": "An indication of whether CTE concentrators are included in the state's computation of its graduation rate." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "federalProgramsFundingAllocation": { + "type": "number", + "description": "The amount of federal dollars distributed to Local Education Agencies (LEAs), retained by the State Education Agency (SEA) for program administration or other approved state-level activities (including unallocated, transferred to another state agency, or distributed to entities other than LEAs)." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "stateEducationAgencyId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StateEducationAgency", + "description": "This entity represents the agency of the state charged with the primary responsibility for coordinating and supervising public instruction, including the setting of standards for elementary and secondary instructional programs.", + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "cteGraduationRateInclusion": { + "type": "boolean", + "description": "An indication of whether CTE concentrators are included in the state's computation of its graduation rate." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "federalProgramsFundingAllocation": { + "type": "number", + "description": "The amount of federal dollars distributed to Local Education Agencies (LEAs), retained by the State Education Agency (SEA) for program administration or other approved state-level activities (including unallocated, transferred to another state agency, or distributed to entities other than LEAs)." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the person moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, this would be the date the person moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the EducationOrganization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the EducationOrganization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "StateEducationAgencyId" + ], + "documentPathsMapping": { + "StateEducationAgencyId": [ + "$.stateEducationAgencyId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "studentCTEProgramAssociations": { + "resourceName": "StudentCTEProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCTEProgramAssociation", + "description": "This association represents the career and technical education (CTE) program that a student participates in. The association is an extension of the StudentProgramAssociation particular for CTE programs.", + "type": "object", + "properties": { + "ctePrograms": { + "type": "array", + "items": { + "type": "object", + "properties": { + "careerPathwayDescriptor": { + "type": "string", + "description": "A sequence of courses within an area of interest that is a student's educational road map to a chosen career." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP Code associated with the student's CTEProgram.", + "minLength": 1, + "maxLength": 120 + }, + "primaryCTEProgramIndicator": { + "type": "boolean", + "description": "A boolean indicator of whether this CTEProgram, is the student's primary CTEProgram." + }, + "cteProgramCompletionIndicator": { + "type": "boolean", + "description": "A boolean indicator of whether the Student has completed the CTEProgram." + } + }, + "additionalProperties": false, + "required": [ + "careerPathwayDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nonTraditionalGenderStatus": { + "type": "boolean", + "description": "Indicator that student is from a gender group that comprises less than 25% of the individuals employed in an occupation or field of work." + }, + "privateCTEProgram": { + "type": "boolean", + "description": "Indicator that student participated in career and technical education at private agencies or institutions that are reported by the state for purposes of the Elementary and Secondary Education Act (ESEA).Students in private institutions which do not receive Perkins funding are reported only in the state file." + }, + "technicalSkillsAssessmentDescriptor": { + "type": "string", + "description": "Results of technical skills assessment aligned with industry recognized standards." + }, + "cteProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cteProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the CTE Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP Code associated with the student's CTE Program.", + "minLength": 1, + "maxLength": 120 + } + }, + "additionalProperties": false, + "required": [ + "cteProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCTEProgramAssociation", + "description": "This association represents the career and technical education (CTE) program that a student participates in. The association is an extension of the StudentProgramAssociation particular for CTE programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "ctePrograms": { + "type": "array", + "items": { + "type": "object", + "properties": { + "careerPathwayDescriptor": { + "type": "string", + "description": "A sequence of courses within an area of interest that is a student's educational road map to a chosen career." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP Code associated with the student's CTEProgram.", + "minLength": 1, + "maxLength": 120 + }, + "primaryCTEProgramIndicator": { + "type": "boolean", + "description": "A boolean indicator of whether this CTEProgram, is the student's primary CTEProgram." + }, + "cteProgramCompletionIndicator": { + "type": "boolean", + "description": "A boolean indicator of whether the Student has completed the CTEProgram." + } + }, + "additionalProperties": false, + "required": [ + "careerPathwayDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nonTraditionalGenderStatus": { + "type": "boolean", + "description": "Indicator that student is from a gender group that comprises less than 25% of the individuals employed in an occupation or field of work." + }, + "privateCTEProgram": { + "type": "boolean", + "description": "Indicator that student participated in career and technical education at private agencies or institutions that are reported by the state for purposes of the Elementary and Secondary Education Act (ESEA).Students in private institutions which do not receive Perkins funding are reported only in the state file." + }, + "technicalSkillsAssessmentDescriptor": { + "type": "string", + "description": "Results of technical skills assessment aligned with industry recognized standards." + }, + "cteProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cteProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the CTE Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP Code associated with the student's CTE Program.", + "minLength": 1, + "maxLength": 120 + } + }, + "additionalProperties": false, + "required": [ + "cteProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCTEProgramAssociation", + "description": "This association represents the career and technical education (CTE) program that a student participates in. The association is an extension of the StudentProgramAssociation particular for CTE programs.", + "type": "object", + "properties": { + "ctePrograms": { + "type": "array", + "items": { + "type": "object", + "properties": { + "careerPathwayDescriptor": { + "type": "string", + "description": "A sequence of courses within an area of interest that is a student's educational road map to a chosen career." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP Code associated with the student's CTEProgram.", + "minLength": 1, + "maxLength": 120 + }, + "primaryCTEProgramIndicator": { + "type": "boolean", + "description": "A boolean indicator of whether this CTEProgram, is the student's primary CTEProgram." + }, + "cteProgramCompletionIndicator": { + "type": "boolean", + "description": "A boolean indicator of whether the Student has completed the CTEProgram." + } + }, + "additionalProperties": false, + "required": [ + "careerPathwayDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nonTraditionalGenderStatus": { + "type": "boolean", + "description": "Indicator that student is from a gender group that comprises less than 25% of the individuals employed in an occupation or field of work." + }, + "privateCTEProgram": { + "type": "boolean", + "description": "Indicator that student participated in career and technical education at private agencies or institutions that are reported by the state for purposes of the Elementary and Secondary Education Act (ESEA).Students in private institutions which do not receive Perkins funding are reported only in the state file." + }, + "technicalSkillsAssessmentDescriptor": { + "type": "string", + "description": "Results of technical skills assessment aligned with industry recognized standards." + }, + "cteProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cteProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the CTE Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP Code associated with the student's CTE Program.", + "minLength": 1, + "maxLength": 120 + } + }, + "additionalProperties": false, + "required": [ + "cteProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "NonTraditionalGenderStatus": [ + "$.nonTraditionalGenderStatus" + ], + "PrivateCTEProgram": [ + "$.privateCTEProgram" + ], + "TechnicalSkillsAssessment": [ + "$.technicalSkillsAssessmentDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentHomelessProgramAssociations": { + "resourceName": "StudentHomelessProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentHomelessProgramAssociation", + "description": "This association represents the McKinney-Vento Homeless Program program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "homelessPrimaryNighttimeResidenceDescriptor": { + "type": "string", + "description": "The primary nighttime residence of the student at the time the student is identified as homeless." + }, + "awaitingFosterCare": { + "type": "boolean", + "description": "State defined definition for awaiting foster care." + }, + "homelessUnaccompaniedYouth": { + "type": "boolean", + "description": "A homeless unaccompanied youth is a youth who is not in the physical custody of a parent or guardian and who fits the McKinney-Vento definition of homeless. Students must be both unaccompanied and homeless to be included as an unaccompanied homeless youth." + }, + "homelessProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "homelessProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Homeless Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "homelessProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentHomelessProgramAssociation", + "description": "This association represents the McKinney-Vento Homeless Program program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "homelessPrimaryNighttimeResidenceDescriptor": { + "type": "string", + "description": "The primary nighttime residence of the student at the time the student is identified as homeless." + }, + "awaitingFosterCare": { + "type": "boolean", + "description": "State defined definition for awaiting foster care." + }, + "homelessUnaccompaniedYouth": { + "type": "boolean", + "description": "A homeless unaccompanied youth is a youth who is not in the physical custody of a parent or guardian and who fits the McKinney-Vento definition of homeless. Students must be both unaccompanied and homeless to be included as an unaccompanied homeless youth." + }, + "homelessProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "homelessProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Homeless Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "homelessProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentHomelessProgramAssociation", + "description": "This association represents the McKinney-Vento Homeless Program program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "homelessPrimaryNighttimeResidenceDescriptor": { + "type": "string", + "description": "The primary nighttime residence of the student at the time the student is identified as homeless." + }, + "awaitingFosterCare": { + "type": "boolean", + "description": "State defined definition for awaiting foster care." + }, + "homelessUnaccompaniedYouth": { + "type": "boolean", + "description": "A homeless unaccompanied youth is a youth who is not in the physical custody of a parent or guardian and who fits the McKinney-Vento definition of homeless. Students must be both unaccompanied and homeless to be included as an unaccompanied homeless youth." + }, + "homelessProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "homelessProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Homeless Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "homelessProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "HomelessPrimaryNighttimeResidence": [ + "$.homelessPrimaryNighttimeResidenceDescriptor" + ], + "AwaitingFosterCare": [ + "$.awaitingFosterCare" + ], + "HomelessUnaccompaniedYouth": [ + "$.homelessUnaccompaniedYouth" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentLanguageInstructionProgramAssociations": { + "resourceName": "StudentLanguageInstructionProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLanguageInstructionProgramAssociation", + "description": "This association represents the Title III Language Instruction for Limited English Proficient and Immigrant Students program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "englishLanguageProficiencyAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "participationDescriptor": { + "type": "string", + "description": "Field indicating the participation in the yearly English language assessment." + }, + "proficiencyDescriptor": { + "type": "string", + "description": "The proficiency level for the yearly English language assessment." + }, + "progressDescriptor": { + "type": "string", + "description": "The yearly progress or growth from last year's assessment." + }, + "monitoredDescriptor": { + "type": "string", + "description": "Student is monitored on content achievement who are no longer receiving services." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "englishLearnerParticipation": { + "type": "boolean", + "description": "An indication that an English Learner student is served by an English language instruction educational program supported with Title III of ESEA funds." + }, + "languageInstructionProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageInstructionProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Language Instruction Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "languageInstructionProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "dosage": { + "type": "integer", + "description": "The duration of time in minutes for which the student was assigned to participate in the program." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLanguageInstructionProgramAssociation", + "description": "This association represents the Title III Language Instruction for Limited English Proficient and Immigrant Students program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "englishLanguageProficiencyAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "participationDescriptor": { + "type": "string", + "description": "Field indicating the participation in the yearly English language assessment." + }, + "proficiencyDescriptor": { + "type": "string", + "description": "The proficiency level for the yearly English language assessment." + }, + "progressDescriptor": { + "type": "string", + "description": "The yearly progress or growth from last year's assessment." + }, + "monitoredDescriptor": { + "type": "string", + "description": "Student is monitored on content achievement who are no longer receiving services." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "englishLearnerParticipation": { + "type": "boolean", + "description": "An indication that an English Learner student is served by an English language instruction educational program supported with Title III of ESEA funds." + }, + "languageInstructionProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageInstructionProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Language Instruction Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "languageInstructionProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "dosage": { + "type": "integer", + "description": "The duration of time in minutes for which the student was assigned to participate in the program." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLanguageInstructionProgramAssociation", + "description": "This association represents the Title III Language Instruction for Limited English Proficient and Immigrant Students program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "englishLanguageProficiencyAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "participationDescriptor": { + "type": "string", + "description": "Field indicating the participation in the yearly English language assessment." + }, + "proficiencyDescriptor": { + "type": "string", + "description": "The proficiency level for the yearly English language assessment." + }, + "progressDescriptor": { + "type": "string", + "description": "The yearly progress or growth from last year's assessment." + }, + "monitoredDescriptor": { + "type": "string", + "description": "Student is monitored on content achievement who are no longer receiving services." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "englishLearnerParticipation": { + "type": "boolean", + "description": "An indication that an English Learner student is served by an English language instruction educational program supported with Title III of ESEA funds." + }, + "languageInstructionProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageInstructionProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Language Instruction Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "languageInstructionProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "dosage": { + "type": "integer", + "description": "The duration of time in minutes for which the student was assigned to participate in the program." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "EnglishLearnerParticipation": [ + "$.englishLearnerParticipation" + ], + "Dosage": [ + "$.dosage" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentMigrantEducationProgramAssociations": { + "resourceName": "StudentMigrantEducationProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentMigrantEducationProgramAssociation", + "description": "This association represents the migrant education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation with added elements particular to migrant education programs.", + "type": "object", + "properties": { + "priorityForServices": { + "type": "boolean", + "description": "Report migratory children who are classified as having \"priority for services\" because they are failing, or most at risk of failing to meet the State's challenging State academic content standards and challenging State student academic achievement standards, and their education has been interrupted during the regular school year." + }, + "lastQualifyingMove": { + "type": "string", + "format": "date", + "description": "Date the last qualifying move occurred; used to compute MEP status." + }, + "continuationOfServicesReasonDescriptor": { + "type": "string", + "description": "The \"continuation of services\" provision found in Section 1304(e) of the statute provides that (1) a child who ceases to be a migratory child during a school term shall be eligible for services until the end of such term; (2) a child who is no longer a migratory child may continue to receive services for one additional school year, but only if comparable services are not available through other programs; and (3) secondary school students who were eligible for services in secondary school may continue to be served through credit accrual programs until graduation. Only students who received services at any time during their 36 month eligibility period may continue to receive services (not necessarily the same service)." + }, + "usInitialEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student first entered the U.S." + }, + "usMostRecentEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the Student's most recent entry into the U.S." + }, + "usInitialSchoolEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student first entered a U.S. school." + }, + "qualifyingArrivalDate": { + "type": "string", + "format": "date", + "description": "The Qualifying Arrival Date (QAD) is the date the child joins the worker who has already moved, or the date when the worker joins the child who has already moved. The QAD is the date that the child's eligibility for the MEP begins. The QAD is not affected by subsequent non-qualifying moves." + }, + "stateResidencyDate": { + "type": "string", + "format": "date", + "description": "The verified State residency for the student." + }, + "eligibilityExpirationDate": { + "type": "string", + "format": "date", + "description": "The Eligibility Expiration Date is used to determine end of eligibility and to account for a child's eligibility expiring earlier than 36 months from the child's QAD. A child's eligibility would end earlier than 36 months from the child's QAD, if the child is no longer entitled to a free public education (e.g., graduated with a high school diploma, obtained a high school equivalency diploma (HSED), or for other reasons as determined by States' requirements), or if the child passes away." + }, + "migrantEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "migrantEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Migrant Education Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "migrantEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "priorityForServices", + "lastQualifyingMove", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentMigrantEducationProgramAssociation", + "description": "This association represents the migrant education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation with added elements particular to migrant education programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "priorityForServices": { + "type": "boolean", + "description": "Report migratory children who are classified as having \"priority for services\" because they are failing, or most at risk of failing to meet the State's challenging State academic content standards and challenging State student academic achievement standards, and their education has been interrupted during the regular school year." + }, + "lastQualifyingMove": { + "type": "string", + "format": "date", + "description": "Date the last qualifying move occurred; used to compute MEP status." + }, + "continuationOfServicesReasonDescriptor": { + "type": "string", + "description": "The \"continuation of services\" provision found in Section 1304(e) of the statute provides that (1) a child who ceases to be a migratory child during a school term shall be eligible for services until the end of such term; (2) a child who is no longer a migratory child may continue to receive services for one additional school year, but only if comparable services are not available through other programs; and (3) secondary school students who were eligible for services in secondary school may continue to be served through credit accrual programs until graduation. Only students who received services at any time during their 36 month eligibility period may continue to receive services (not necessarily the same service)." + }, + "usInitialEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student first entered the U.S." + }, + "usMostRecentEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the Student's most recent entry into the U.S." + }, + "usInitialSchoolEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student first entered a U.S. school." + }, + "qualifyingArrivalDate": { + "type": "string", + "format": "date", + "description": "The Qualifying Arrival Date (QAD) is the date the child joins the worker who has already moved, or the date when the worker joins the child who has already moved. The QAD is the date that the child's eligibility for the MEP begins. The QAD is not affected by subsequent non-qualifying moves." + }, + "stateResidencyDate": { + "type": "string", + "format": "date", + "description": "The verified State residency for the student." + }, + "eligibilityExpirationDate": { + "type": "string", + "format": "date", + "description": "The Eligibility Expiration Date is used to determine end of eligibility and to account for a child's eligibility expiring earlier than 36 months from the child's QAD. A child's eligibility would end earlier than 36 months from the child's QAD, if the child is no longer entitled to a free public education (e.g., graduated with a high school diploma, obtained a high school equivalency diploma (HSED), or for other reasons as determined by States' requirements), or if the child passes away." + }, + "migrantEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "migrantEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Migrant Education Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "migrantEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "priorityForServices", + "lastQualifyingMove", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentMigrantEducationProgramAssociation", + "description": "This association represents the migrant education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation with added elements particular to migrant education programs.", + "type": "object", + "properties": { + "priorityForServices": { + "type": "boolean", + "description": "Report migratory children who are classified as having \"priority for services\" because they are failing, or most at risk of failing to meet the State's challenging State academic content standards and challenging State student academic achievement standards, and their education has been interrupted during the regular school year." + }, + "lastQualifyingMove": { + "type": "string", + "format": "date", + "description": "Date the last qualifying move occurred; used to compute MEP status." + }, + "continuationOfServicesReasonDescriptor": { + "type": "string", + "description": "The \"continuation of services\" provision found in Section 1304(e) of the statute provides that (1) a child who ceases to be a migratory child during a school term shall be eligible for services until the end of such term; (2) a child who is no longer a migratory child may continue to receive services for one additional school year, but only if comparable services are not available through other programs; and (3) secondary school students who were eligible for services in secondary school may continue to be served through credit accrual programs until graduation. Only students who received services at any time during their 36 month eligibility period may continue to receive services (not necessarily the same service)." + }, + "usInitialEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student first entered the U.S." + }, + "usMostRecentEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the Student's most recent entry into the U.S." + }, + "usInitialSchoolEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student first entered a U.S. school." + }, + "qualifyingArrivalDate": { + "type": "string", + "format": "date", + "description": "The Qualifying Arrival Date (QAD) is the date the child joins the worker who has already moved, or the date when the worker joins the child who has already moved. The QAD is the date that the child's eligibility for the MEP begins. The QAD is not affected by subsequent non-qualifying moves." + }, + "stateResidencyDate": { + "type": "string", + "format": "date", + "description": "The verified State residency for the student." + }, + "eligibilityExpirationDate": { + "type": "string", + "format": "date", + "description": "The Eligibility Expiration Date is used to determine end of eligibility and to account for a child's eligibility expiring earlier than 36 months from the child's QAD. A child's eligibility would end earlier than 36 months from the child's QAD, if the child is no longer entitled to a free public education (e.g., graduated with a high school diploma, obtained a high school equivalency diploma (HSED), or for other reasons as determined by States' requirements), or if the child passes away." + }, + "migrantEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "migrantEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Migrant Education Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "migrantEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "PriorityForServices": [ + "$.priorityForServices" + ], + "LastQualifyingMove": [ + "$.lastQualifyingMove" + ], + "ContinuationOfServicesReason": [ + "$.continuationOfServicesReasonDescriptor" + ], + "USInitialEntry": [ + "$.usInitialEntry" + ], + "USMostRecentEntry": [ + "$.usMostRecentEntry" + ], + "USInitialSchoolEntry": [ + "$.usInitialSchoolEntry" + ], + "QualifyingArrivalDate": [ + "$.qualifyingArrivalDate" + ], + "StateResidencyDate": [ + "$.stateResidencyDate" + ], + "EligibilityExpirationDate": [ + "$.eligibilityExpirationDate" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentNeglectedOrDelinquentProgramAssociations": { + "resourceName": "StudentNeglectedOrDelinquentProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentNeglectedOrDelinquentProgramAssociation", + "description": "This association represents the Title I Part D Neglected or Delinquent program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "neglectedOrDelinquentProgramDescriptor": { + "type": "string", + "description": "The type of program under ESEA Title I, Part D, Subpart 1 (state programs) or Subpart 2 (LEA)." + }, + "elaProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post- test for ELA." + }, + "mathematicsProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post-test for Mathematics." + }, + "neglectedOrDelinquentProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "neglectedOrDelinquentProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Neglected or Delinquent Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "neglectedOrDelinquentProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentNeglectedOrDelinquentProgramAssociation", + "description": "This association represents the Title I Part D Neglected or Delinquent program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "neglectedOrDelinquentProgramDescriptor": { + "type": "string", + "description": "The type of program under ESEA Title I, Part D, Subpart 1 (state programs) or Subpart 2 (LEA)." + }, + "elaProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post- test for ELA." + }, + "mathematicsProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post-test for Mathematics." + }, + "neglectedOrDelinquentProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "neglectedOrDelinquentProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Neglected or Delinquent Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "neglectedOrDelinquentProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentNeglectedOrDelinquentProgramAssociation", + "description": "This association represents the Title I Part D Neglected or Delinquent program(s) that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "neglectedOrDelinquentProgramDescriptor": { + "type": "string", + "description": "The type of program under ESEA Title I, Part D, Subpart 1 (state programs) or Subpart 2 (LEA)." + }, + "elaProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post- test for ELA." + }, + "mathematicsProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post-test for Mathematics." + }, + "neglectedOrDelinquentProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "neglectedOrDelinquentProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Neglected or Delinquent Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "neglectedOrDelinquentProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "NeglectedOrDelinquentProgram": [ + "$.neglectedOrDelinquentProgramDescriptor" + ], + "ELAProgressLevel": [ + "$.elaProgressLevelDescriptor" + ], + "MathematicsProgressLevel": [ + "$.mathematicsProgressLevelDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentProgramAssociations": { + "resourceName": "StudentProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAssociation", + "description": "This association represents the Program(s) that a student participates in or is served by.", + "type": "object", + "properties": { + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAssociation", + "description": "This association represents the Program(s) that a student participates in or is served by.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAssociation", + "description": "This association represents the Program(s) that a student participates in or is served by.", + "type": "object", + "properties": { + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentSchoolFoodServiceProgramAssociations": { + "resourceName": "StudentSchoolFoodServiceProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolFoodServiceProgramAssociation", + "description": "This association represents the school food services program(s), such as the Free or Reduced Lunch Program, that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "directCertification": { + "type": "boolean", + "description": "Indicates that the student's National School Lunch Program (NSLP) eligibility has been determined through direct certification." + }, + "schoolFoodServiceProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolFoodServiceProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the School Food Service Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "schoolFoodServiceProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolFoodServiceProgramAssociation", + "description": "This association represents the school food services program(s), such as the Free or Reduced Lunch Program, that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "directCertification": { + "type": "boolean", + "description": "Indicates that the student's National School Lunch Program (NSLP) eligibility has been determined through direct certification." + }, + "schoolFoodServiceProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolFoodServiceProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the School Food Service Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "schoolFoodServiceProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolFoodServiceProgramAssociation", + "description": "This association represents the school food services program(s), such as the Free or Reduced Lunch Program, that a student participates in or from which the Student receives services.", + "type": "object", + "properties": { + "directCertification": { + "type": "boolean", + "description": "Indicates that the student's National School Lunch Program (NSLP) eligibility has been determined through direct certification." + }, + "schoolFoodServiceProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolFoodServiceProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the School Food Service Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "schoolFoodServiceProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "DirectCertification": [ + "$.directCertification" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentSpecialEducationProgramAssociations": { + "resourceName": "StudentSpecialEducationProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSpecialEducationProgramAssociation", + "description": "This association represents the special education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation particular for special education programs.", + "type": "object", + "properties": { + "ideaEligibility": { + "type": "boolean", + "description": "Indicator of the eligibility of the student to receive special education services according to the Individuals with Disabilities Education Act (IDEA)." + }, + "specialEducationSettingDescriptor": { + "type": "string", + "description": "The major instructional setting (more than 50 percent of a student's special education program)." + }, + "serviceProviders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationHoursPerWeek": { + "type": "number", + "description": "The number of hours per week for special education instruction and therapy." + }, + "schoolHoursPerWeek": { + "type": "number", + "description": "Indicate the total number of hours of instructional time per week for the school that the student attends." + }, + "multiplyDisabled": { + "type": "boolean", + "description": "Indicates whether the Student receiving special education and related services has been designated as multiply disabled by the admission, review, and dismissal committee as aligned with federal requirements." + }, + "medicallyFragile": { + "type": "boolean", + "description": "Indicates whether the Student receiving special education and related services is: 1) in the age range of birth to 22 years, and 2) has a serious, ongoing illness or a chronic condition that has lasted or is anticipated to last at least 12 or more months or has required at least one month of hospitalization, and that requires daily, ongoing medical treatments and monitoring by appropriately trained personnel which may include parents or other family members, and 3) requires the routine use of medical device or of assistive technology to compensate for the loss of usefulness of a body function needed to participate in activities of daily living, and 4) lives with ongoing threat to his or her continued well-being. Aligns with federal requirements." + }, + "lastEvaluationDate": { + "type": "string", + "format": "date", + "description": "The date of the last special education evaluation." + }, + "iepReviewDate": { + "type": "string", + "format": "date", + "description": "The date of the last IEP review." + }, + "iepBeginDate": { + "type": "string", + "format": "date", + "description": "The effective date of the most recent IEP." + }, + "iepEndDate": { + "type": "string", + "format": "date", + "description": "The end date of the most recent IEP." + }, + "disabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDescriptor": { + "type": "string", + "description": "A disability category that describes a child's impairment." + }, + "disabilityDiagnosis": { + "type": "string", + "description": "A description of the disability diagnosis.", + "minLength": 1, + "maxLength": 80 + }, + "orderOfDisability": { + "type": "integer", + "description": "The order by severity of student's disabilities: 1- Primary, 2 - Secondary, 3 - Tertiary, etc." + }, + "disabilityDeterminationSourceTypeDescriptor": { + "type": "string", + "description": "The source that provided the disability determination." + }, + "designations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDesignationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disabilityDesignationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "disabilityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Special Education Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + }, + "providers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "specialEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSpecialEducationProgramAssociation", + "description": "This association represents the special education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation particular for special education programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "ideaEligibility": { + "type": "boolean", + "description": "Indicator of the eligibility of the student to receive special education services according to the Individuals with Disabilities Education Act (IDEA)." + }, + "specialEducationSettingDescriptor": { + "type": "string", + "description": "The major instructional setting (more than 50 percent of a student's special education program)." + }, + "serviceProviders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationHoursPerWeek": { + "type": "number", + "description": "The number of hours per week for special education instruction and therapy." + }, + "schoolHoursPerWeek": { + "type": "number", + "description": "Indicate the total number of hours of instructional time per week for the school that the student attends." + }, + "multiplyDisabled": { + "type": "boolean", + "description": "Indicates whether the Student receiving special education and related services has been designated as multiply disabled by the admission, review, and dismissal committee as aligned with federal requirements." + }, + "medicallyFragile": { + "type": "boolean", + "description": "Indicates whether the Student receiving special education and related services is: 1) in the age range of birth to 22 years, and 2) has a serious, ongoing illness or a chronic condition that has lasted or is anticipated to last at least 12 or more months or has required at least one month of hospitalization, and that requires daily, ongoing medical treatments and monitoring by appropriately trained personnel which may include parents or other family members, and 3) requires the routine use of medical device or of assistive technology to compensate for the loss of usefulness of a body function needed to participate in activities of daily living, and 4) lives with ongoing threat to his or her continued well-being. Aligns with federal requirements." + }, + "lastEvaluationDate": { + "type": "string", + "format": "date", + "description": "The date of the last special education evaluation." + }, + "iepReviewDate": { + "type": "string", + "format": "date", + "description": "The date of the last IEP review." + }, + "iepBeginDate": { + "type": "string", + "format": "date", + "description": "The effective date of the most recent IEP." + }, + "iepEndDate": { + "type": "string", + "format": "date", + "description": "The end date of the most recent IEP." + }, + "disabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDescriptor": { + "type": "string", + "description": "A disability category that describes a child's impairment." + }, + "disabilityDiagnosis": { + "type": "string", + "description": "A description of the disability diagnosis.", + "minLength": 1, + "maxLength": 80 + }, + "orderOfDisability": { + "type": "integer", + "description": "The order by severity of student's disabilities: 1- Primary, 2 - Secondary, 3 - Tertiary, etc." + }, + "disabilityDeterminationSourceTypeDescriptor": { + "type": "string", + "description": "The source that provided the disability determination." + }, + "designations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDesignationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disabilityDesignationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "disabilityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Special Education Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + }, + "providers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "specialEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSpecialEducationProgramAssociation", + "description": "This association represents the special education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation particular for special education programs.", + "type": "object", + "properties": { + "ideaEligibility": { + "type": "boolean", + "description": "Indicator of the eligibility of the student to receive special education services according to the Individuals with Disabilities Education Act (IDEA)." + }, + "specialEducationSettingDescriptor": { + "type": "string", + "description": "The major instructional setting (more than 50 percent of a student's special education program)." + }, + "serviceProviders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationHoursPerWeek": { + "type": "number", + "description": "The number of hours per week for special education instruction and therapy." + }, + "schoolHoursPerWeek": { + "type": "number", + "description": "Indicate the total number of hours of instructional time per week for the school that the student attends." + }, + "multiplyDisabled": { + "type": "boolean", + "description": "Indicates whether the Student receiving special education and related services has been designated as multiply disabled by the admission, review, and dismissal committee as aligned with federal requirements." + }, + "medicallyFragile": { + "type": "boolean", + "description": "Indicates whether the Student receiving special education and related services is: 1) in the age range of birth to 22 years, and 2) has a serious, ongoing illness or a chronic condition that has lasted or is anticipated to last at least 12 or more months or has required at least one month of hospitalization, and that requires daily, ongoing medical treatments and monitoring by appropriately trained personnel which may include parents or other family members, and 3) requires the routine use of medical device or of assistive technology to compensate for the loss of usefulness of a body function needed to participate in activities of daily living, and 4) lives with ongoing threat to his or her continued well-being. Aligns with federal requirements." + }, + "lastEvaluationDate": { + "type": "string", + "format": "date", + "description": "The date of the last special education evaluation." + }, + "iepReviewDate": { + "type": "string", + "format": "date", + "description": "The date of the last IEP review." + }, + "iepBeginDate": { + "type": "string", + "format": "date", + "description": "The effective date of the most recent IEP." + }, + "iepEndDate": { + "type": "string", + "format": "date", + "description": "The end date of the most recent IEP." + }, + "disabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDescriptor": { + "type": "string", + "description": "A disability category that describes a child's impairment." + }, + "disabilityDiagnosis": { + "type": "string", + "description": "A description of the disability diagnosis.", + "minLength": 1, + "maxLength": 80 + }, + "orderOfDisability": { + "type": "integer", + "description": "The order by severity of student's disabilities: 1- Primary, 2 - Secondary, 3 - Tertiary, etc." + }, + "disabilityDeterminationSourceTypeDescriptor": { + "type": "string", + "description": "The source that provided the disability determination." + }, + "designations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDesignationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disabilityDesignationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "disabilityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Special Education Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + }, + "providers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "specialEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "IdeaEligibility": [ + "$.ideaEligibility" + ], + "SpecialEducationSetting": [ + "$.specialEducationSettingDescriptor" + ], + "SpecialEducationHoursPerWeek": [ + "$.specialEducationHoursPerWeek" + ], + "SchoolHoursPerWeek": [ + "$.schoolHoursPerWeek" + ], + "MultiplyDisabled": [ + "$.multiplyDisabled" + ], + "MedicallyFragile": [ + "$.medicallyFragile" + ], + "LastEvaluationDate": [ + "$.lastEvaluationDate" + ], + "IEPReviewDate": [ + "$.iepReviewDate" + ], + "IEPBeginDate": [ + "$.iepBeginDate" + ], + "IEPEndDate": [ + "$.iepEndDate" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentTitleIPartAProgramAssociations": { + "resourceName": "StudentTitleIPartAProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentTitleIPartAProgramAssociation", + "description": "This association represents the Title I Part A program(s) that a student participates in or from which the Student receives services. The association is an extension of the StudentProgramAssociation particular for Title I Part A programs.", + "type": "object", + "properties": { + "titleIPartAParticipantDescriptor": { + "type": "string", + "description": "An indication of the type of Title I program, if any, in which the student is participating and by which the student is served: Public Targeted Assistance Program Public Schoolwide Program Private School Students Participating Local Neglected Program." + }, + "titleIPartAProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "titleIPartAProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Title I Part A Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAParticipantDescriptor", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentTitleIPartAProgramAssociation", + "description": "This association represents the Title I Part A program(s) that a student participates in or from which the Student receives services. The association is an extension of the StudentProgramAssociation particular for Title I Part A programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "titleIPartAParticipantDescriptor": { + "type": "string", + "description": "An indication of the type of Title I program, if any, in which the student is participating and by which the student is served: Public Targeted Assistance Program Public Schoolwide Program Private School Students Participating Local Neglected Program." + }, + "titleIPartAProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "titleIPartAProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Title I Part A Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "titleIPartAParticipantDescriptor", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentTitleIPartAProgramAssociation", + "description": "This association represents the Title I Part A program(s) that a student participates in or from which the Student receives services. The association is an extension of the StudentProgramAssociation particular for Title I Part A programs.", + "type": "object", + "properties": { + "titleIPartAParticipantDescriptor": { + "type": "string", + "description": "An indication of the type of Title I program, if any, in which the student is participating and by which the student is served: Public Targeted Assistance Program Public Schoolwide Program Private School Students Participating Local Neglected Program." + }, + "titleIPartAProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "titleIPartAProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Title I Part A Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the Service being provided to the student by the Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the Student exited the Program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the child left the Program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the Student received services during the summer session or between sessions." + }, + "participationStatus": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor" + ] + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "TitleIPartAParticipant": [ + "$.titleIPartAParticipantDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "absenceEventCategoryDescriptors": { + "resourceName": "AbsenceEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "academicHonorCategoryDescriptors": { + "resourceName": "AcademicHonorCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "academicSubjectDescriptors": { + "resourceName": "AcademicSubjectDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "accommodationDescriptors": { + "resourceName": "AccommodationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "accountClassificationDescriptors": { + "resourceName": "AccountClassificationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "achievementCategoryDescriptors": { + "resourceName": "AchievementCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "additionalCreditTypeDescriptors": { + "resourceName": "AdditionalCreditTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "addressTypeDescriptors": { + "resourceName": "AddressTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "administrationEnvironmentDescriptors": { + "resourceName": "AdministrationEnvironmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "administrativeFundingControlDescriptors": { + "resourceName": "AdministrativeFundingControlDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "ancestryEthnicOriginDescriptors": { + "resourceName": "AncestryEthnicOriginDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentCategoryDescriptors": { + "resourceName": "AssessmentCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentIdentificationSystemDescriptors": { + "resourceName": "AssessmentIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentItemCategoryDescriptors": { + "resourceName": "AssessmentItemCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentItemResultDescriptors": { + "resourceName": "AssessmentItemResultDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentPeriodDescriptors": { + "resourceName": "AssessmentPeriodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentReportingMethodDescriptors": { + "resourceName": "AssessmentReportingMethodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "attemptStatusDescriptors": { + "resourceName": "AttemptStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "attendanceEventCategoryDescriptors": { + "resourceName": "AttendanceEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "barrierToInternetAccessInResidenceDescriptors": { + "resourceName": "BarrierToInternetAccessInResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "behaviorDescriptors": { + "resourceName": "BehaviorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "calendarEventDescriptors": { + "resourceName": "CalendarEventDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "calendarTypeDescriptors": { + "resourceName": "CalendarTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "careerPathwayDescriptors": { + "resourceName": "CareerPathwayDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "charterApprovalAgencyTypeDescriptors": { + "resourceName": "CharterApprovalAgencyTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "charterStatusDescriptors": { + "resourceName": "CharterStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "citizenshipStatusDescriptors": { + "resourceName": "CitizenshipStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "classroomPositionDescriptors": { + "resourceName": "ClassroomPositionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cohortScopeDescriptors": { + "resourceName": "CohortScopeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cohortTypeDescriptors": { + "resourceName": "CohortTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cohortYearTypeDescriptors": { + "resourceName": "CohortYearTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "competencyLevelDescriptors": { + "resourceName": "CompetencyLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "contactTypeDescriptors": { + "resourceName": "ContactTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "contentClassDescriptors": { + "resourceName": "ContentClassDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "continuationOfServicesReasonDescriptors": { + "resourceName": "ContinuationOfServicesReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "costRateDescriptors": { + "resourceName": "CostRateDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "countryDescriptors": { + "resourceName": "CountryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseAttemptResultDescriptors": { + "resourceName": "CourseAttemptResultDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseDefinedByDescriptors": { + "resourceName": "CourseDefinedByDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseGPAApplicabilityDescriptors": { + "resourceName": "CourseGPAApplicabilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseIdentificationSystemDescriptors": { + "resourceName": "CourseIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseLevelCharacteristicDescriptors": { + "resourceName": "CourseLevelCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseRepeatCodeDescriptors": { + "resourceName": "CourseRepeatCodeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "credentialFieldDescriptors": { + "resourceName": "CredentialFieldDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "credentialTypeDescriptors": { + "resourceName": "CredentialTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "creditCategoryDescriptors": { + "resourceName": "CreditCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "creditTypeDescriptors": { + "resourceName": "CreditTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cTEProgramServiceDescriptors": { + "resourceName": "CTEProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "curriculumUsedDescriptors": { + "resourceName": "CurriculumUsedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "deliveryMethodDescriptors": { + "resourceName": "DeliveryMethodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "diagnosisDescriptors": { + "resourceName": "DiagnosisDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "diplomaLevelDescriptors": { + "resourceName": "DiplomaLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "diplomaTypeDescriptors": { + "resourceName": "DiplomaTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disabilityDescriptors": { + "resourceName": "DisabilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disabilityDesignationDescriptors": { + "resourceName": "DisabilityDesignationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disabilityDeterminationSourceTypeDescriptors": { + "resourceName": "DisabilityDeterminationSourceTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disciplineDescriptors": { + "resourceName": "DisciplineDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disciplineActionLengthDifferenceReasonDescriptors": { + "resourceName": "DisciplineActionLengthDifferenceReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disciplineIncidentParticipationCodeDescriptors": { + "resourceName": "DisciplineIncidentParticipationCodeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationalEnvironmentDescriptors": { + "resourceName": "EducationalEnvironmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationOrganizationCategoryDescriptors": { + "resourceName": "EducationOrganizationCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationOrganizationIdentificationSystemDescriptors": { + "resourceName": "EducationOrganizationIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationPlanDescriptors": { + "resourceName": "EducationPlanDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "electronicMailTypeDescriptors": { + "resourceName": "ElectronicMailTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "employmentStatusDescriptors": { + "resourceName": "EmploymentStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "entryGradeLevelReasonDescriptors": { + "resourceName": "EntryGradeLevelReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "entryTypeDescriptors": { + "resourceName": "EntryTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "eventCircumstanceDescriptors": { + "resourceName": "EventCircumstanceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "exitWithdrawTypeDescriptors": { + "resourceName": "ExitWithdrawTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradebookEntryTypeDescriptors": { + "resourceName": "GradebookEntryTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradeLevelDescriptors": { + "resourceName": "GradeLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradePointAverageTypeDescriptors": { + "resourceName": "GradePointAverageTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradeTypeDescriptors": { + "resourceName": "GradeTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradingPeriodDescriptors": { + "resourceName": "GradingPeriodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "graduationPlanTypeDescriptors": { + "resourceName": "GraduationPlanTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gunFreeSchoolsActReportingStatusDescriptors": { + "resourceName": "GunFreeSchoolsActReportingStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "homelessPrimaryNighttimeResidenceDescriptors": { + "resourceName": "HomelessPrimaryNighttimeResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "homelessProgramServiceDescriptors": { + "resourceName": "HomelessProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "identificationDocumentUseDescriptors": { + "resourceName": "IdentificationDocumentUseDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "incidentLocationDescriptors": { + "resourceName": "IncidentLocationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "indicatorDescriptors": { + "resourceName": "IndicatorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "indicatorGroupDescriptors": { + "resourceName": "IndicatorGroupDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "indicatorLevelDescriptors": { + "resourceName": "IndicatorLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "institutionTelephoneNumberTypeDescriptors": { + "resourceName": "InstitutionTelephoneNumberTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "interactivityStyleDescriptors": { + "resourceName": "InteractivityStyleDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "internetAccessDescriptors": { + "resourceName": "InternetAccessDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "internetAccessTypeInResidenceDescriptors": { + "resourceName": "InternetAccessTypeInResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "internetPerformanceInResidenceDescriptors": { + "resourceName": "InternetPerformanceInResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "interventionClassDescriptors": { + "resourceName": "InterventionClassDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "interventionEffectivenessRatingDescriptors": { + "resourceName": "InterventionEffectivenessRatingDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "languageDescriptors": { + "resourceName": "LanguageDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "languageInstructionProgramServiceDescriptors": { + "resourceName": "LanguageInstructionProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "languageUseDescriptors": { + "resourceName": "LanguageUseDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "learningStandardCategoryDescriptors": { + "resourceName": "LearningStandardCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "learningStandardEquivalenceStrengthDescriptors": { + "resourceName": "LearningStandardEquivalenceStrengthDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "learningStandardScopeDescriptors": { + "resourceName": "LearningStandardScopeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "levelOfEducationDescriptors": { + "resourceName": "LevelOfEducationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "licenseStatusDescriptors": { + "resourceName": "LicenseStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "licenseTypeDescriptors": { + "resourceName": "LicenseTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "limitedEnglishProficiencyDescriptors": { + "resourceName": "LimitedEnglishProficiencyDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "localeDescriptors": { + "resourceName": "LocaleDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "localEducationAgencyCategoryDescriptors": { + "resourceName": "LocalEducationAgencyCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "magnetSpecialProgramEmphasisSchoolDescriptors": { + "resourceName": "MagnetSpecialProgramEmphasisSchoolDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "mediumOfInstructionDescriptors": { + "resourceName": "MediumOfInstructionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "methodCreditEarnedDescriptors": { + "resourceName": "MethodCreditEarnedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "migrantEducationProgramServiceDescriptors": { + "resourceName": "MigrantEducationProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "monitoredDescriptors": { + "resourceName": "MonitoredDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "neglectedOrDelinquentProgramDescriptors": { + "resourceName": "NeglectedOrDelinquentProgramDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "neglectedOrDelinquentProgramServiceDescriptors": { + "resourceName": "NeglectedOrDelinquentProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "networkPurposeDescriptors": { + "resourceName": "NetworkPurposeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "oldEthnicityDescriptors": { + "resourceName": "OldEthnicityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "operationalStatusDescriptors": { + "resourceName": "OperationalStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "otherNameTypeDescriptors": { + "resourceName": "OtherNameTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "participationDescriptors": { + "resourceName": "ParticipationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "participationStatusDescriptors": { + "resourceName": "ParticipationStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "performanceBaseConversionDescriptors": { + "resourceName": "PerformanceBaseConversionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "performanceLevelDescriptors": { + "resourceName": "PerformanceLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "personalInformationVerificationDescriptors": { + "resourceName": "PersonalInformationVerificationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "platformTypeDescriptors": { + "resourceName": "PlatformTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "populationServedDescriptors": { + "resourceName": "PopulationServedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "postingResultDescriptors": { + "resourceName": "PostingResultDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "postSecondaryEventCategoryDescriptors": { + "resourceName": "PostSecondaryEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "postSecondaryInstitutionLevelDescriptors": { + "resourceName": "PostSecondaryInstitutionLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "primaryLearningDeviceAccessDescriptors": { + "resourceName": "PrimaryLearningDeviceAccessDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "primaryLearningDeviceAwayFromSchoolDescriptors": { + "resourceName": "PrimaryLearningDeviceAwayFromSchoolDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "primaryLearningDeviceProviderDescriptors": { + "resourceName": "PrimaryLearningDeviceProviderDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "proficiencyDescriptors": { + "resourceName": "ProficiencyDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programAssignmentDescriptors": { + "resourceName": "ProgramAssignmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programCharacteristicDescriptors": { + "resourceName": "ProgramCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programSponsorDescriptors": { + "resourceName": "ProgramSponsorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programTypeDescriptors": { + "resourceName": "ProgramTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "progressDescriptors": { + "resourceName": "ProgressDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "progressLevelDescriptors": { + "resourceName": "ProgressLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "providerCategoryDescriptors": { + "resourceName": "ProviderCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "providerProfitabilityDescriptors": { + "resourceName": "ProviderProfitabilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "providerStatusDescriptors": { + "resourceName": "ProviderStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "publicationStatusDescriptors": { + "resourceName": "PublicationStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "questionFormDescriptors": { + "resourceName": "QuestionFormDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "raceDescriptors": { + "resourceName": "RaceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "reasonExitedDescriptors": { + "resourceName": "ReasonExitedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "reasonNotTestedDescriptors": { + "resourceName": "ReasonNotTestedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "recognitionTypeDescriptors": { + "resourceName": "RecognitionTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "relationDescriptors": { + "resourceName": "RelationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "repeatIdentifierDescriptors": { + "resourceName": "RepeatIdentifierDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "reporterDescriptionDescriptors": { + "resourceName": "ReporterDescriptionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "residencyStatusDescriptors": { + "resourceName": "ResidencyStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "responseIndicatorDescriptors": { + "resourceName": "ResponseIndicatorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "responsibilityDescriptors": { + "resourceName": "ResponsibilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "restraintEventReasonDescriptors": { + "resourceName": "RestraintEventReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "resultDatatypeTypeDescriptors": { + "resourceName": "ResultDatatypeTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "retestIndicatorDescriptors": { + "resourceName": "RetestIndicatorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolCategoryDescriptors": { + "resourceName": "SchoolCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolChoiceImplementStatusDescriptors": { + "resourceName": "SchoolChoiceImplementStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolFoodServiceProgramServiceDescriptors": { + "resourceName": "SchoolFoodServiceProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolTypeDescriptors": { + "resourceName": "SchoolTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "sectionCharacteristicDescriptors": { + "resourceName": "SectionCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "separationDescriptors": { + "resourceName": "SeparationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "separationReasonDescriptors": { + "resourceName": "SeparationReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "serviceDescriptors": { + "resourceName": "ServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "sexDescriptors": { + "resourceName": "SexDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "sourceSystemDescriptors": { + "resourceName": "SourceSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "specialEducationProgramServiceDescriptors": { + "resourceName": "SpecialEducationProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "specialEducationSettingDescriptors": { + "resourceName": "SpecialEducationSettingDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "staffClassificationDescriptors": { + "resourceName": "StaffClassificationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "staffIdentificationSystemDescriptors": { + "resourceName": "StaffIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "staffLeaveEventCategoryDescriptors": { + "resourceName": "StaffLeaveEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "stateAbbreviationDescriptors": { + "resourceName": "StateAbbreviationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "studentCharacteristicDescriptors": { + "resourceName": "StudentCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "studentIdentificationSystemDescriptors": { + "resourceName": "StudentIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "studentParticipationCodeDescriptors": { + "resourceName": "StudentParticipationCodeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "surveyCategoryDescriptors": { + "resourceName": "SurveyCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "surveyLevelDescriptors": { + "resourceName": "SurveyLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "teachingCredentialDescriptors": { + "resourceName": "TeachingCredentialDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "teachingCredentialBasisDescriptors": { + "resourceName": "TeachingCredentialBasisDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "technicalSkillsAssessmentDescriptors": { + "resourceName": "TechnicalSkillsAssessmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "telephoneNumberTypeDescriptors": { + "resourceName": "TelephoneNumberTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "termDescriptors": { + "resourceName": "TermDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "titleIPartAParticipantDescriptors": { + "resourceName": "TitleIPartAParticipantDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "titleIPartAProgramServiceDescriptors": { + "resourceName": "TitleIPartAProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "titleIPartASchoolDesignationDescriptors": { + "resourceName": "TitleIPartASchoolDesignationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "tribalAffiliationDescriptors": { + "resourceName": "TribalAffiliationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "visaDescriptors": { + "resourceName": "VisaDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "weaponDescriptors": { + "resourceName": "WeaponDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + } + } + } + } +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-5.0.0-pre.1.json b/Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-5.0.0-pre.1.json new file mode 100644 index 00000000..500b9d6f --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/ds-schemas/DataStandard-5.0.0-pre.1.json @@ -0,0 +1,73500 @@ +{ + "projectSchemas": { + "ed-fi": { + "projectName": "Ed-Fi", + "projectVersion": "5.0.0-pre.1", + "isExtensionProject": false, + "description": "The Ed-Fi Data Model 5.0", + "resourceSchemas": { + "academicWeeks": { + "resourceName": "AcademicWeek", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AcademicWeek", + "description": "This entity represents the academic weeks for a school year, optionally captured to support analyses.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the academic week." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the academic week." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total instructional days during the academic week.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "weekIdentifier", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AcademicWeek", + "description": "This entity represents the academic weeks for a school year, optionally captured to support analyses.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the academic week." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the academic week." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total instructional days during the academic week.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "weekIdentifier", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AcademicWeek", + "description": "This entity represents the academic weeks for a school year, optionally captured to support analyses.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the academic week." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the academic week." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total instructional days during the academic week.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "WeekIdentifier" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "WeekIdentifier": [ + "$.weekIdentifier" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "TotalInstructionalDays": [ + "$.totalInstructionalDays" + ] + } + }, + "accountabilityRatings": { + "resourceName": "AccountabilityRating", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountabilityRating", + "description": "An accountability rating for a school or district.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "ratingTitle": { + "type": "string", + "description": "The title of the rating.", + "minLength": 1, + "maxLength": 60 + }, + "rating": { + "type": "string", + "description": "An accountability rating level, designation, or assessment.", + "minLength": 1, + "maxLength": 35 + }, + "ratingDate": { + "type": "string", + "format": "date", + "description": "The date the rating was awarded." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "ratingOrganization": { + "type": "string", + "description": "The organization that assessed the rating.", + "minLength": 1, + "maxLength": 35 + }, + "ratingProgram": { + "type": "string", + "description": "The program associated with the accountability rating (e.g., NCLB, AEIS).", + "minLength": 1, + "maxLength": 30 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationReference", + "ratingTitle", + "rating", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountabilityRating", + "description": "An accountability rating for a school or district.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "ratingTitle": { + "type": "string", + "description": "The title of the rating.", + "minLength": 1, + "maxLength": 60 + }, + "rating": { + "type": "string", + "description": "An accountability rating level, designation, or assessment.", + "minLength": 1, + "maxLength": 35 + }, + "ratingDate": { + "type": "string", + "format": "date", + "description": "The date the rating was awarded." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "ratingOrganization": { + "type": "string", + "description": "The organization that assessed the rating.", + "minLength": 1, + "maxLength": 35 + }, + "ratingProgram": { + "type": "string", + "description": "The program associated with the accountability rating (e.g., NCLB, AEIS).", + "minLength": 1, + "maxLength": 30 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationOrganizationReference", + "ratingTitle", + "rating", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AccountabilityRating", + "description": "An accountability rating for a school or district.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "ratingTitle": { + "type": "string", + "description": "The title of the rating.", + "minLength": 1, + "maxLength": 60 + }, + "rating": { + "type": "string", + "description": "An accountability rating level, designation, or assessment.", + "minLength": 1, + "maxLength": 35 + }, + "ratingDate": { + "type": "string", + "format": "date", + "description": "The date the rating was awarded." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "ratingOrganization": { + "type": "string", + "description": "The organization that assessed the rating.", + "minLength": 1, + "maxLength": 35 + }, + "ratingProgram": { + "type": "string", + "description": "The program associated with the accountability rating (e.g., NCLB, AEIS).", + "minLength": 1, + "maxLength": 30 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "RatingTitle", + "SchoolYear" + ], + "documentPathsMapping": { + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "RatingTitle": [ + "$.ratingTitle" + ], + "Rating": [ + "$.rating" + ], + "RatingDate": [ + "$.ratingDate" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "RatingOrganization": [ + "$.ratingOrganization" + ], + "RatingProgram": [ + "$.ratingProgram" + ] + } + }, + "assessments": { + "resourceName": "Assessment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Assessment", + "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.", + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentTitle": { + "type": "string", + "description": "The title or name of the assessment.", + "minLength": 1, + "maxLength": 255 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the assessment identification code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentCategoryDescriptor": { + "type": "string", + "description": "The category of an assessment based on format and content." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "assessedGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "assessmentForm": { + "type": "string", + "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentVersion": { + "type": "integer", + "description": "The version identifier for the assessment." + }, + "revisionDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for assessment.", + "minLength": 1, + "maxLength": 100 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentFamily": { + "type": "string", + "description": "The assessment family this assessment is a member of.", + "minLength": 1, + "maxLength": 60 + }, + "sections": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "sectionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "adaptiveAssessment": { + "type": "boolean", + "description": "Indicates that the assessment is adaptive." + }, + "platformTypes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "platformTypeDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "platformTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "assessmentTitle", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Assessment", + "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.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentTitle": { + "type": "string", + "description": "The title or name of the assessment.", + "minLength": 1, + "maxLength": 255 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the assessment identification code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentCategoryDescriptor": { + "type": "string", + "description": "The category of an assessment based on format and content." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "assessedGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "assessmentForm": { + "type": "string", + "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentVersion": { + "type": "integer", + "description": "The version identifier for the assessment." + }, + "revisionDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for assessment.", + "minLength": 1, + "maxLength": 100 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentFamily": { + "type": "string", + "description": "The assessment family this assessment is a member of.", + "minLength": 1, + "maxLength": 60 + }, + "sections": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "sectionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "adaptiveAssessment": { + "type": "boolean", + "description": "Indicates that the assessment is adaptive." + }, + "platformTypes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "platformTypeDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "platformTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "assessmentIdentifier", + "assessmentTitle", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Assessment", + "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.", + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentTitle": { + "type": "string", + "description": "The title or name of the assessment.", + "minLength": 1, + "maxLength": 255 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the assessment identification code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentCategoryDescriptor": { + "type": "string", + "description": "The category of an assessment based on format and content." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "assessedGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "assessmentForm": { + "type": "string", + "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentVersion": { + "type": "integer", + "description": "The version identifier for the assessment." + }, + "revisionDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for assessment.", + "minLength": 1, + "maxLength": 100 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentFamily": { + "type": "string", + "description": "The assessment family this assessment is a member of.", + "minLength": 1, + "maxLength": 60 + }, + "sections": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "sectionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "adaptiveAssessment": { + "type": "boolean", + "description": "Indicates that the assessment is adaptive." + }, + "platformTypes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "platformTypeDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "platformTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "AssessmentIdentifier", + "Namespace" + ], + "documentPathsMapping": { + "AssessmentIdentifier": [ + "$.assessmentIdentifier" + ], + "AssessmentTitle": [ + "$.assessmentTitle" + ], + "AssessmentCategory": [ + "$.assessmentCategoryDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "AssessedGradeLevel": [ + "$.assessedGradeLevels[*].gradeLevelDescriptor" + ], + "AssessmentForm": [ + "$.assessmentForm" + ], + "Language": [ + "$.languages[*].languageDescriptor" + ], + "AssessmentVersion": [ + "$.assessmentVersion" + ], + "RevisionDate": [ + "$.revisionDate" + ], + "MaxRawScore": [ + "$.maxRawScore" + ], + "Nomenclature": [ + "$.nomenclature" + ], + "AssessmentFamily": [ + "$.assessmentFamily" + ], + "Namespace": [ + "$.namespace" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "AdaptiveAssessment": [ + "$.adaptiveAssessment" + ], + "PlatformType": [ + "$.platformTypes[*].platformTypeDescriptor" + ] + } + }, + "assessmentItems": { + "resourceName": "AssessmentItem", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentItem", + "description": "This entity represents one of many single measures that make up an assessment.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentItemCategoryDescriptor": { + "type": "string", + "description": "Category or type of the assessment item." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "itemText": { + "type": "string", + "description": "The text of the item.", + "minLength": 1, + "maxLength": 1024 + }, + "possibleResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "responseValue": { + "type": "string", + "description": "The response value, often an option number or code value (e.g., 1, 2, A, B, true, false).", + "minLength": 1, + "maxLength": 60 + }, + "responseDescription": { + "type": "string", + "description": "Additional text provided to define the response value.", + "minLength": 1, + "maxLength": 1024 + }, + "correctResponse": { + "type": "boolean", + "description": "Indicates the response is correct." + } + }, + "additionalProperties": false, + "required": [ + "responseValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expectedTimeAssessed": { + "type": "number", + "description": "The duration of time allotted for the assessment item." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for assessment item.", + "minLength": 1, + "maxLength": 100 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "assessmentItemURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentItem", + "description": "This entity represents one of many single measures that make up an assessment.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentItemCategoryDescriptor": { + "type": "string", + "description": "Category or type of the assessment item." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "itemText": { + "type": "string", + "description": "The text of the item.", + "minLength": 1, + "maxLength": 1024 + }, + "possibleResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "responseValue": { + "type": "string", + "description": "The response value, often an option number or code value (e.g., 1, 2, A, B, true, false).", + "minLength": 1, + "maxLength": 60 + }, + "responseDescription": { + "type": "string", + "description": "Additional text provided to define the response value.", + "minLength": 1, + "maxLength": 1024 + }, + "correctResponse": { + "type": "boolean", + "description": "Indicates the response is correct." + } + }, + "additionalProperties": false, + "required": [ + "responseValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expectedTimeAssessed": { + "type": "number", + "description": "The duration of time allotted for the assessment item." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for assessment item.", + "minLength": 1, + "maxLength": 100 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "assessmentItemURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentItem", + "description": "This entity represents one of many single measures that make up an assessment.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentItemCategoryDescriptor": { + "type": "string", + "description": "Category or type of the assessment item." + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "itemText": { + "type": "string", + "description": "The text of the item.", + "minLength": 1, + "maxLength": 1024 + }, + "possibleResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "responseValue": { + "type": "string", + "description": "The response value, often an option number or code value (e.g., 1, 2, A, B, true, false).", + "minLength": 1, + "maxLength": 60 + }, + "responseDescription": { + "type": "string", + "description": "Additional text provided to define the response value.", + "minLength": 1, + "maxLength": 1024 + }, + "correctResponse": { + "type": "boolean", + "description": "Indicates the response is correct." + } + }, + "additionalProperties": false, + "required": [ + "responseValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expectedTimeAssessed": { + "type": "number", + "description": "The duration of time allotted for the assessment item." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for assessment item.", + "minLength": 1, + "maxLength": 100 + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "assessmentItemURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "IdentificationCode", + "Assessment" + ], + "documentPathsMapping": { + "IdentificationCode": [ + "$.identificationCode" + ], + "AssessmentItemCategory": [ + "$.assessmentItemCategoryDescriptor" + ], + "MaxRawScore": [ + "$.maxRawScore" + ], + "ItemText": [ + "$.itemText" + ], + "ExpectedTimeAssessed": [ + "$.expectedTimeAssessed" + ], + "Nomenclature": [ + "$.nomenclature" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "AssessmentItemURI": [ + "$.assessmentItemURI" + ] + } + }, + "assessmentScoreRangeLearningStandards": { + "resourceName": "AssessmentScoreRangeLearningStandard", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentScoreRangeLearningStandard", + "description": "Score ranges of an assessment associated with one or more learning standards.", + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "scoreRangeId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s)." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference", + "learningStandards", + "scoreRangeId", + "minimumScore", + "maximumScore" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentScoreRangeLearningStandard", + "description": "Score ranges of an assessment associated with one or more learning standards.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "scoreRangeId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s)." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "assessmentReference", + "learningStandards", + "scoreRangeId", + "minimumScore", + "maximumScore" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.AssessmentScoreRangeLearningStandard", + "description": "Score ranges of an assessment associated with one or more learning standards.", + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "scoreRangeId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", + "minLength": 1, + "maxLength": 60 + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s)." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score in the score range.", + "minLength": 1, + "maxLength": 35 + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.objectiveAssessmentReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.objectiveAssessmentReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + } + ], + "identityFullnames": [ + "Assessment", + "ScoreRangeId" + ], + "documentPathsMapping": { + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "ScoreRangeId": [ + "$.scoreRangeId" + ], + "AssessmentReportingMethod": [ + "$.assessmentReportingMethodDescriptor" + ], + "MinimumScore": [ + "$.minimumScore" + ], + "MaximumScore": [ + "$.maximumScore" + ], + "ObjectiveAssessment": [ + "$.objectiveAssessmentReference.assessmentIdentifier", + "$.objectiveAssessmentReference.identificationCode", + "$.objectiveAssessmentReference.namespace" + ] + } + }, + "balanceSheetDimensions": { + "resourceName": "BalanceSheetDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BalanceSheetDimension", + "description": "The NCES balance sheet accounting dimension, used to track financial transactions for each fund. These financial statements only report assets, deferred outflows of resources, liabilities, deferred inflows of resources, and equity accounts. The statements are considered snapshots of how these accounts stand as of a certain point in time.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account balance sheet dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BalanceSheetDimension", + "description": "The NCES balance sheet accounting dimension, used to track financial transactions for each fund. These financial statements only report assets, deferred outflows of resources, liabilities, deferred inflows of resources, and equity accounts. The statements are considered snapshots of how these accounts stand as of a certain point in time.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account balance sheet dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BalanceSheetDimension", + "description": "The NCES balance sheet accounting dimension, used to track financial transactions for each fund. These financial statements only report assets, deferred outflows of resources, liabilities, deferred inflows of resources, and equity accounts. The statements are considered snapshots of how these accounts stand as of a certain point in time.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account balance sheet dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "bellSchedules": { + "resourceName": "BellSchedule", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BellSchedule", + "description": "This entity represents the schedule of class period meeting times.", + "type": "object", + "properties": { + "bellScheduleName": { + "type": "string", + "description": "Name or title of the bell schedule.", + "minLength": 1, + "maxLength": 60 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "dates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The dates for which the bell schedule applies." + } + }, + "additionalProperties": false, + "required": [ + "date" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "alternateDayName": { + "type": "string", + "description": "An alternate name for the day (e.g., Red, Blue).", + "minLength": 1, + "maxLength": 20 + }, + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule ends." + }, + "totalInstructionalTime": { + "type": "integer", + "description": "The total instructional time in minutes per day for the bell schedule." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "bellScheduleName", + "schoolReference", + "classPeriods" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BellSchedule", + "description": "This entity represents the schedule of class period meeting times.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "bellScheduleName": { + "type": "string", + "description": "Name or title of the bell schedule.", + "minLength": 1, + "maxLength": 60 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "dates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The dates for which the bell schedule applies." + } + }, + "additionalProperties": false, + "required": [ + "date" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "alternateDayName": { + "type": "string", + "description": "An alternate name for the day (e.g., Red, Blue).", + "minLength": 1, + "maxLength": 20 + }, + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule ends." + }, + "totalInstructionalTime": { + "type": "integer", + "description": "The total instructional time in minutes per day for the bell schedule." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "bellScheduleName", + "schoolReference", + "classPeriods" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.BellSchedule", + "description": "This entity represents the schedule of class period meeting times.", + "type": "object", + "properties": { + "bellScheduleName": { + "type": "string", + "description": "Name or title of the bell schedule.", + "minLength": 1, + "maxLength": 60 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "dates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The dates for which the bell schedule applies." + } + }, + "additionalProperties": false, + "required": [ + "date" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "alternateDayName": { + "type": "string", + "description": "An alternate name for the day (e.g., Red, Blue).", + "minLength": 1, + "maxLength": 20 + }, + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the bell schedule ends." + }, + "totalInstructionalTime": { + "type": "integer", + "description": "The total instructional time in minutes per day for the bell schedule." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.classPeriods[*].classPeriodReference.schoolId", + "targetJsonPath": "$.schoolReference.schoolId" + } + ], + "identityFullnames": [ + "BellScheduleName", + "School" + ], + "documentPathsMapping": { + "BellScheduleName": [ + "$.bellScheduleName" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "ClassPeriod": [ + "$.classPeriods[*].classPeriodReference.classPeriodName", + "$.classPeriods[*].classPeriodReference.schoolId" + ], + "Date": [ + "$.dates[*].date" + ], + "AlternateDayName": [ + "$.alternateDayName" + ], + "StartTime": [ + "$.startTime" + ], + "EndTime": [ + "$.endTime" + ], + "TotalInstructionalTime": [ + "$.totalInstructionalTime" + ] + } + }, + "calendars": { + "resourceName": "Calendar", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Calendar", + "description": "A set of dates associated with an organization.", + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "calendarTypeDescriptor": { + "type": "string", + "description": "Indicates the type of calendar." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "calendarTypeDescriptor", + "schoolReference", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Calendar", + "description": "A set of dates associated with an organization.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "calendarTypeDescriptor": { + "type": "string", + "description": "Indicates the type of calendar." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "calendarCode", + "calendarTypeDescriptor", + "schoolReference", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Calendar", + "description": "A set of dates associated with an organization.", + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "calendarTypeDescriptor": { + "type": "string", + "description": "Indicates the type of calendar." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CalendarCode", + "School", + "SchoolYear" + ], + "documentPathsMapping": { + "CalendarCode": [ + "$.calendarCode" + ], + "CalendarType": [ + "$.calendarTypeDescriptor" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ] + } + }, + "calendarDates": { + "resourceName": "CalendarDate", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CalendarDate", + "description": "The type of scheduled or unscheduled event for the day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the calendar event." + }, + "calendarEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "calendarEventDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "calendarEventDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "calendarReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "date", + "calendarEvents", + "calendarReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CalendarDate", + "description": "The type of scheduled or unscheduled event for the day.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the calendar event." + }, + "calendarEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "calendarEventDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "calendarEventDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "calendarReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "date", + "calendarEvents", + "calendarReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CalendarDate", + "description": "The type of scheduled or unscheduled event for the day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the calendar event." + }, + "calendarEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "calendarEventDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "calendarEventDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "calendarReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Date", + "Calendar" + ], + "documentPathsMapping": { + "Date": [ + "$.date" + ], + "CalendarEvent": [ + "$.calendarEvents[*].calendarEventDescriptor" + ], + "Calendar": [ + "$.calendarReference.calendarCode", + "$.calendarReference.schoolId", + "$.calendarReference.schoolYear" + ] + } + }, + "chartOfAccounts": { + "resourceName": "ChartOfAccount", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ChartOfAccount", + "description": "A valid combination of account dimensions under which financials are reported. This financial entity represents a funding source combined with its purpose and type of transaction. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", + "minLength": 1, + "maxLength": 50 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account", + "minimum": 2020, + "maximum": 2040 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "accountTypeDescriptor": { + "type": "string", + "description": "The type of account used in accounting such as revenue, expenditure, or balance sheet." + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "balanceSheetBalanceSheetDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account balance sheet dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "functionFunctionDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account function dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account function dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "fundFundDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account fund dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account fund dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "objectObjectDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account object dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account object dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "operationalUnitOperationalUnitDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account operational unit dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account operational unit dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "programProgramDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account program dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account program dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "projectProjectDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account project dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account project dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "sourceSourceDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account source dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account source dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tagValue": { + "type": "string", + "description": "The value associated with the reporting tag.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTagDescriptor": { + "type": "string", + "description": "A descriptor used at the dimension and/or chart of account levels to demote specific state needs for reporting." + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "fiscalYear", + "educationOrganizationReference", + "accountTypeDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ChartOfAccount", + "description": "A valid combination of account dimensions under which financials are reported. This financial entity represents a funding source combined with its purpose and type of transaction. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "accountIdentifier": { + "type": "string", + "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", + "minLength": 1, + "maxLength": 50 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account", + "minimum": 2020, + "maximum": 2040 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "accountTypeDescriptor": { + "type": "string", + "description": "The type of account used in accounting such as revenue, expenditure, or balance sheet." + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "balanceSheetBalanceSheetDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account balance sheet dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "functionFunctionDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account function dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account function dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "fundFundDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account fund dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account fund dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "objectObjectDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account object dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account object dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "operationalUnitOperationalUnitDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account operational unit dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account operational unit dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "programProgramDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account program dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account program dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "projectProjectDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account project dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account project dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "sourceSourceDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account source dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account source dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tagValue": { + "type": "string", + "description": "The value associated with the reporting tag.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTagDescriptor": { + "type": "string", + "description": "A descriptor used at the dimension and/or chart of account levels to demote specific state needs for reporting." + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "accountIdentifier", + "fiscalYear", + "educationOrganizationReference", + "accountTypeDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ChartOfAccount", + "description": "A valid combination of account dimensions under which financials are reported. This financial entity represents a funding source combined with its purpose and type of transaction. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", + "minLength": 1, + "maxLength": 50 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account", + "minimum": 2020, + "maximum": 2040 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "accountTypeDescriptor": { + "type": "string", + "description": "The type of account used in accounting such as revenue, expenditure, or balance sheet." + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "balanceSheetBalanceSheetDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account balance sheet dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account balance sheet dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "functionFunctionDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account function dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account function dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "fundFundDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account fund dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account fund dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "objectObjectDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account object dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account object dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "operationalUnitOperationalUnitDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account operational unit dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account operational unit dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "programProgramDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account program dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account program dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "projectProjectDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account project dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account project dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "sourceSourceDimensionReference": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account source dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account source dimension is valid.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tagValue": { + "type": "string", + "description": "The value associated with the reporting tag.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTagDescriptor": { + "type": "string", + "description": "A descriptor used at the dimension and/or chart of account levels to demote specific state needs for reporting." + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.balanceSheetBalanceSheetDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + }, + { + "sourceJsonPath": "$.functionFunctionDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + }, + { + "sourceJsonPath": "$.fundFundDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + }, + { + "sourceJsonPath": "$.objectObjectDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + }, + { + "sourceJsonPath": "$.operationalUnitOperationalUnitDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + }, + { + "sourceJsonPath": "$.programProgramDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + }, + { + "sourceJsonPath": "$.projectProjectDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + }, + { + "sourceJsonPath": "$.sourceSourceDimensionReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + } + ], + "identityFullnames": [ + "AccountIdentifier", + "FiscalYear", + "EducationOrganization" + ], + "documentPathsMapping": { + "AccountIdentifier": [ + "$.accountIdentifier" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "AccountType": [ + "$.accountTypeDescriptor" + ], + "AccountName": [ + "$.accountName" + ], + "BalanceSheetBalanceSheetDimension": [ + "$.balanceSheetBalanceSheetDimensionReference.code", + "$.balanceSheetBalanceSheetDimensionReference.fiscalYear" + ], + "FunctionFunctionDimension": [ + "$.functionFunctionDimensionReference.code", + "$.functionFunctionDimensionReference.fiscalYear" + ], + "FundFundDimension": [ + "$.fundFundDimensionReference.code", + "$.fundFundDimensionReference.fiscalYear" + ], + "ObjectObjectDimension": [ + "$.objectObjectDimensionReference.code", + "$.objectObjectDimensionReference.fiscalYear" + ], + "OperationalUnitOperationalUnitDimension": [ + "$.operationalUnitOperationalUnitDimensionReference.code", + "$.operationalUnitOperationalUnitDimensionReference.fiscalYear" + ], + "ProgramProgramDimension": [ + "$.programProgramDimensionReference.code", + "$.programProgramDimensionReference.fiscalYear" + ], + "ProjectProjectDimension": [ + "$.projectProjectDimensionReference.code", + "$.projectProjectDimensionReference.fiscalYear" + ], + "SourceSourceDimension": [ + "$.sourceSourceDimensionReference.code", + "$.sourceSourceDimensionReference.fiscalYear" + ] + } + }, + "classPeriods": { + "resourceName": "ClassPeriod", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ClassPeriod", + "description": "This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "classPeriodName" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ClassPeriod", + "description": "This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "classPeriodName" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ClassPeriod", + "description": "This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "ClassPeriodName" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "ClassPeriodName": [ + "$.classPeriodName" + ], + "OfficialAttendancePeriod": [ + "$.officialAttendancePeriod" + ] + } + }, + "cohorts": { + "resourceName": "Cohort", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Cohort", + "description": "This entity represents any type of list of designated students for tracking, analysis, or intervention.", + "type": "object", + "properties": { + "cohortIdentifier": { + "type": "string", + "description": "The name or ID for the cohort.", + "minLength": 1, + "maxLength": 36 + }, + "cohortDescription": { + "type": "string", + "description": "The description of the cohort and its purpose.", + "minLength": 1, + "maxLength": 1024 + }, + "cohortTypeDescriptor": { + "type": "string", + "description": "The type of cohort (e.g., academic intervention, classroom breakout)." + }, + "cohortScopeDescriptor": { + "type": "string", + "description": "The scope of cohort (e.g., school, district, classroom)." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The academic subject associated with an academic intervention." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "cohortIdentifier", + "cohortTypeDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Cohort", + "description": "This entity represents any type of list of designated students for tracking, analysis, or intervention.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "cohortIdentifier": { + "type": "string", + "description": "The name or ID for the cohort.", + "minLength": 1, + "maxLength": 36 + }, + "cohortDescription": { + "type": "string", + "description": "The description of the cohort and its purpose.", + "minLength": 1, + "maxLength": 1024 + }, + "cohortTypeDescriptor": { + "type": "string", + "description": "The type of cohort (e.g., academic intervention, classroom breakout)." + }, + "cohortScopeDescriptor": { + "type": "string", + "description": "The scope of cohort (e.g., school, district, classroom)." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The academic subject associated with an academic intervention." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "cohortIdentifier", + "cohortTypeDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Cohort", + "description": "This entity represents any type of list of designated students for tracking, analysis, or intervention.", + "type": "object", + "properties": { + "cohortIdentifier": { + "type": "string", + "description": "The name or ID for the cohort.", + "minLength": 1, + "maxLength": 36 + }, + "cohortDescription": { + "type": "string", + "description": "The description of the cohort and its purpose.", + "minLength": 1, + "maxLength": 1024 + }, + "cohortTypeDescriptor": { + "type": "string", + "description": "The type of cohort (e.g., academic intervention, classroom breakout)." + }, + "cohortScopeDescriptor": { + "type": "string", + "description": "The scope of cohort (e.g., school, district, classroom)." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The academic subject associated with an academic intervention." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CohortIdentifier", + "EducationOrganization" + ], + "documentPathsMapping": { + "CohortIdentifier": [ + "$.cohortIdentifier" + ], + "CohortDescription": [ + "$.cohortDescription" + ], + "CohortType": [ + "$.cohortTypeDescriptor" + ], + "CohortScope": [ + "$.cohortScopeDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "Program": [ + "$.programs[*].programReference.educationOrganizationId", + "$.programs[*].programReference.programName", + "$.programs[*].programReference.programTypeDescriptor" + ] + } + }, + "communityProviderLicenses": { + "resourceName": "CommunityProviderLicense", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProviderLicense", + "description": "The legal document held by the community provider that authorizes the holder to perform certain functions and or services.", + "type": "object", + "properties": { + "communityProviderReference": { + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a community provider." + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId" + ] + }, + "licenseIdentifier": { + "type": "string", + "description": "The unique identifier issued by the licensing organization.", + "maxLength": 36 + }, + "licensingOrganization": { + "type": "string", + "description": "The organization issuing the license.", + "minLength": 1, + "maxLength": 75 + }, + "licenseEffectiveDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license is active or becomes effective." + }, + "licenseExpirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license will expire." + }, + "licenseIssueDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active license was issued." + }, + "licenseStatusDescriptor": { + "type": "string", + "description": "An indication of the status of the license." + }, + "licenseTypeDescriptor": { + "type": "string", + "description": "An indication of the category of the license." + }, + "authorizedFacilityCapacity": { + "type": "integer", + "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve." + }, + "oldestAgeAuthorizedToServe": { + "type": "integer", + "description": "The oldest age of children a provider is authorized or licensed to serve." + }, + "youngestAgeAuthorizedToServe": { + "type": "integer", + "description": "The youngest age of children a provider is authorized or licensed to serve." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "communityProviderReference", + "licenseIdentifier", + "licensingOrganization", + "licenseEffectiveDate", + "licenseTypeDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProviderLicense", + "description": "The legal document held by the community provider that authorizes the holder to perform certain functions and or services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "communityProviderReference": { + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a community provider." + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId" + ] + }, + "licenseIdentifier": { + "type": "string", + "description": "The unique identifier issued by the licensing organization.", + "maxLength": 36 + }, + "licensingOrganization": { + "type": "string", + "description": "The organization issuing the license.", + "minLength": 1, + "maxLength": 75 + }, + "licenseEffectiveDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license is active or becomes effective." + }, + "licenseExpirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license will expire." + }, + "licenseIssueDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active license was issued." + }, + "licenseStatusDescriptor": { + "type": "string", + "description": "An indication of the status of the license." + }, + "licenseTypeDescriptor": { + "type": "string", + "description": "An indication of the category of the license." + }, + "authorizedFacilityCapacity": { + "type": "integer", + "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve." + }, + "oldestAgeAuthorizedToServe": { + "type": "integer", + "description": "The oldest age of children a provider is authorized or licensed to serve." + }, + "youngestAgeAuthorizedToServe": { + "type": "integer", + "description": "The youngest age of children a provider is authorized or licensed to serve." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "communityProviderReference", + "licenseIdentifier", + "licensingOrganization", + "licenseEffectiveDate", + "licenseTypeDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProviderLicense", + "description": "The legal document held by the community provider that authorizes the holder to perform certain functions and or services.", + "type": "object", + "properties": { + "communityProviderReference": { + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a community provider." + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId" + ] + }, + "licenseIdentifier": { + "type": "string", + "description": "The unique identifier issued by the licensing organization.", + "maxLength": 36 + }, + "licensingOrganization": { + "type": "string", + "description": "The organization issuing the license.", + "minLength": 1, + "maxLength": 75 + }, + "licenseEffectiveDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license is active or becomes effective." + }, + "licenseExpirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which a license will expire." + }, + "licenseIssueDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active license was issued." + }, + "licenseStatusDescriptor": { + "type": "string", + "description": "An indication of the status of the license." + }, + "licenseTypeDescriptor": { + "type": "string", + "description": "An indication of the category of the license." + }, + "authorizedFacilityCapacity": { + "type": "integer", + "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve." + }, + "oldestAgeAuthorizedToServe": { + "type": "integer", + "description": "The oldest age of children a provider is authorized or licensed to serve." + }, + "youngestAgeAuthorizedToServe": { + "type": "integer", + "description": "The youngest age of children a provider is authorized or licensed to serve." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CommunityProvider" + ], + "documentPathsMapping": { + "CommunityProvider": [ + "$.communityProviderReference.communityProviderId" + ] + } + }, + "competencyObjectives": { + "resourceName": "CompetencyObjective", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CompetencyObjective", + "description": "This entity holds additional competencies for student achievement that are not associated with specific learning objectives (e.g., paying attention in class).", + "type": "object", + "properties": { + "competencyObjectiveId": { + "type": "string", + "description": "The Identifier for the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the student competency objective.", + "minLength": 1, + "maxLength": 1024 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "successCriteria": { + "type": "string", + "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency 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 competency objective.", + "minLength": 1, + "maxLength": 150 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "objective", + "objectiveGradeLevelDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CompetencyObjective", + "description": "This entity holds additional competencies for student achievement that are not associated with specific learning objectives (e.g., paying attention in class).", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "competencyObjectiveId": { + "type": "string", + "description": "The Identifier for the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the student competency objective.", + "minLength": 1, + "maxLength": 1024 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "successCriteria": { + "type": "string", + "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency 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 competency objective.", + "minLength": 1, + "maxLength": 150 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "objective", + "objectiveGradeLevelDescriptor", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CompetencyObjective", + "description": "This entity holds additional competencies for student achievement that are not associated with specific learning objectives (e.g., paying attention in class).", + "type": "object", + "properties": { + "competencyObjectiveId": { + "type": "string", + "description": "The Identifier for the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "description": { + "type": "string", + "description": "The description of the student competency objective.", + "minLength": 1, + "maxLength": 1024 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "successCriteria": { + "type": "string", + "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency 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 competency objective.", + "minLength": 1, + "maxLength": 150 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Objective", + "ObjectiveGradeLevel", + "EducationOrganization" + ], + "documentPathsMapping": { + "CompetencyObjectiveId": [ + "$.competencyObjectiveId" + ], + "Objective": [ + "$.objective" + ], + "Description": [ + "$.description" + ], + "ObjectiveGradeLevel": [ + "$.objectiveGradeLevelDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "SuccessCriteria": [ + "$.successCriteria" + ] + } + }, + "contacts": { + "resourceName": "Contact", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Contact", + "description": "This entity represents a contact of a student, such as a parent, guardian or caretaker.", + "type": "object", + "properties": { + "contactUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a contact.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "contactUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Contact", + "description": "This entity represents a contact of a student, such as a parent, guardian or caretaker.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "contactUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a contact.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "contactUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Contact", + "description": "This entity represents a contact of a student, such as a parent, guardian or caretaker.", + "type": "object", + "properties": { + "contactUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a contact.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "ContactUniqueId" + ], + "documentPathsMapping": { + "ContactUniqueId": [ + "$.contactUniqueId" + ], + "Sex": [ + "$.sexDescriptor" + ], + "LoginId": [ + "$.loginId" + ], + "Person": [ + "$.personReference.personId", + "$.personReference.sourceSystemDescriptor" + ], + "HighestCompletedLevelOfEducation": [ + "$.highestCompletedLevelOfEducationDescriptor" + ] + } + }, + "courses": { + "resourceName": "Course", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Course", + "description": "This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.", + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", + "minLength": 1, + "maxLength": 60 + }, + "numberOfParts": { + "type": "integer", + "description": "The number of parts identified for a course.", + "minimum": 1, + "maximum": 8 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "levelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the course." + }, + "courseDescription": { + "type": "string", + "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", + "minLength": 1, + "maxLength": 1024 + }, + "timeRequiredForCompletion": { + "type": "integer", + "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", + "minimum": 1 + }, + "dateCourseAdopted": { + "type": "string", + "format": "date", + "description": "Date the course was adopted by the education agency." + }, + "highSchoolCourseRequirement": { + "type": "boolean", + "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area." + }, + "courseGPAApplicabilityDescriptor": { + "type": "string", + "description": "An indicator of whether or not the course being described is included in the computation of the student's grade point average, and if so, if it is weighted differently from regular courses." + }, + "courseDefinedByDescriptor": { + "type": "string", + "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization." + }, + "minimumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "maximumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "careerPathwayDescriptor": { + "type": "string", + "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum." + }, + "competencyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "competencyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "competencyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "maxCompletionsForCredit": { + "type": "integer", + "description": "Designates how many times the course may be taken with credit received by the student.", + "minimum": 1 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "courseTitle", + "numberOfParts", + "identificationCodes", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Course", + "description": "This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", + "minLength": 1, + "maxLength": 60 + }, + "numberOfParts": { + "type": "integer", + "description": "The number of parts identified for a course.", + "minimum": 1, + "maximum": 8 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "levelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the course." + }, + "courseDescription": { + "type": "string", + "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", + "minLength": 1, + "maxLength": 1024 + }, + "timeRequiredForCompletion": { + "type": "integer", + "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", + "minimum": 1 + }, + "dateCourseAdopted": { + "type": "string", + "format": "date", + "description": "Date the course was adopted by the education agency." + }, + "highSchoolCourseRequirement": { + "type": "boolean", + "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area." + }, + "courseGPAApplicabilityDescriptor": { + "type": "string", + "description": "An indicator of whether or not the course being described is included in the computation of the student's grade point average, and if so, if it is weighted differently from regular courses." + }, + "courseDefinedByDescriptor": { + "type": "string", + "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization." + }, + "minimumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "maximumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "careerPathwayDescriptor": { + "type": "string", + "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum." + }, + "competencyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "competencyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "competencyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "maxCompletionsForCredit": { + "type": "integer", + "description": "Designates how many times the course may be taken with credit received by the student.", + "minimum": 1 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "courseCode", + "courseTitle", + "numberOfParts", + "identificationCodes", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Course", + "description": "This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.", + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", + "minLength": 1, + "maxLength": 60 + }, + "numberOfParts": { + "type": "integer", + "description": "The number of parts identified for a course.", + "minimum": 1, + "maximum": 8 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "levelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the course." + }, + "courseDescription": { + "type": "string", + "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", + "minLength": 1, + "maxLength": 1024 + }, + "timeRequiredForCompletion": { + "type": "integer", + "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", + "minimum": 1 + }, + "dateCourseAdopted": { + "type": "string", + "format": "date", + "description": "Date the course was adopted by the education agency." + }, + "highSchoolCourseRequirement": { + "type": "boolean", + "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area." + }, + "courseGPAApplicabilityDescriptor": { + "type": "string", + "description": "An indicator of whether or not the course being described is included in the computation of the student's grade point average, and if so, if it is weighted differently from regular courses." + }, + "courseDefinedByDescriptor": { + "type": "string", + "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization." + }, + "minimumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "minimumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "maximumAvailableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "maximumAvailableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "careerPathwayDescriptor": { + "type": "string", + "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum." + }, + "competencyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "competencyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "competencyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "maxCompletionsForCredit": { + "type": "integer", + "description": "Designates how many times the course may be taken with credit received by the student.", + "minimum": 1 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CourseCode", + "EducationOrganization" + ], + "documentPathsMapping": { + "CourseCode": [ + "$.courseCode" + ], + "CourseTitle": [ + "$.courseTitle" + ], + "NumberOfParts": [ + "$.numberOfParts" + ], + "CourseLevelCharacteristic": [ + "$.levelCharacteristics[*].courseLevelCharacteristicDescriptor" + ], + "OfferedGradeLevel": [ + "$.offeredGradeLevels[*].gradeLevelDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ], + "CourseDescription": [ + "$.courseDescription" + ], + "TimeRequiredForCompletion": [ + "$.timeRequiredForCompletion" + ], + "DateCourseAdopted": [ + "$.dateCourseAdopted" + ], + "HighSchoolCourseRequirement": [ + "$.highSchoolCourseRequirement" + ], + "CourseGPAApplicability": [ + "$.courseGPAApplicabilityDescriptor" + ], + "CourseDefinedBy": [ + "$.courseDefinedByDescriptor" + ], + "CareerPathway": [ + "$.careerPathwayDescriptor" + ], + "CompetencyLevel": [ + "$.competencyLevels[*].competencyLevelDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "MaxCompletionsForCredit": [ + "$.maxCompletionsForCredit" + ] + } + }, + "courseOfferings": { + "resourceName": "CourseOffering", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseOffering", + "description": "This entity represents an entry in the course catalog of available courses offered by the school during a session.", + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the course title.", + "minLength": 1, + "maxLength": 60 + }, + "instructionalTimePlanned": { + "type": "integer", + "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", + "minimum": 1 + }, + "curriculumUseds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "curriculumUsedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "curriculumUsedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolReference", + "sessionReference", + "courseReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseOffering", + "description": "This entity represents an entry in the course catalog of available courses offered by the school during a session.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the course title.", + "minLength": 1, + "maxLength": 60 + }, + "instructionalTimePlanned": { + "type": "integer", + "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", + "minimum": 1 + }, + "curriculumUseds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "curriculumUsedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "curriculumUsedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "localCourseCode", + "schoolReference", + "sessionReference", + "courseReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseOffering", + "description": "This entity represents an entry in the course catalog of available courses offered by the school during a session.", + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "localCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the course title.", + "minLength": 1, + "maxLength": 60 + }, + "instructionalTimePlanned": { + "type": "integer", + "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", + "minimum": 1 + }, + "curriculumUseds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "curriculumUsedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "curriculumUsedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.schoolReference.schoolId", + "targetJsonPath": "$.sessionReference.schoolId" + } + ], + "identityFullnames": [ + "LocalCourseCode", + "School", + "Session" + ], + "documentPathsMapping": { + "LocalCourseCode": [ + "$.localCourseCode" + ], + "LocalCourseTitle": [ + "$.localCourseTitle" + ], + "InstructionalTimePlanned": [ + "$.instructionalTimePlanned" + ], + "CurriculumUsed": [ + "$.curriculumUseds[*].curriculumUsedDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "Session": [ + "$.sessionReference.schoolId", + "$.sessionReference.schoolYear", + "$.sessionReference.sessionName" + ], + "Course": [ + "$.courseReference.courseCode", + "$.courseReference.educationOrganizationId" + ], + "CourseLevelCharacteristic": [ + "$.courseLevelCharacteristics[*].courseLevelCharacteristicDescriptor" + ], + "OfferedGradeLevel": [ + "$.offeredGradeLevels[*].gradeLevelDescriptor" + ] + } + }, + "courseTranscripts": { + "resourceName": "CourseTranscript", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseTranscript", + "description": "This entity is the final record of a student's performance in their courses at the end of a semester or school year.", + "type": "object", + "properties": { + "courseAttemptResultDescriptor": { + "type": "string", + "description": "The result from the student's attempt to take the course." + }, + "attemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "earnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "earnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedAdditionalCredits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course" + }, + "additionalCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + } + }, + "additionalProperties": false, + "required": [ + "credits", + "additionalCreditTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "Student's grade level at time of course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "finalLetterGradeEarned": { + "type": "string", + "description": "The final indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "finalNumericGradeEarned": { + "type": "number", + "description": "The final indicator of student performance in a class as submitted by the instructor." + }, + "courseRepeatCodeDescriptor": { + "type": "string", + "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average." + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "studentAcademicRecordReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ] + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "externalEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "externalEducationOrganizationNameOfInstitution": { + "type": "string", + "description": "Name of the external institution where the student completed the course; to be used only when the reference external education organization is not available.", + "minLength": 1, + "maxLength": 75 + }, + "alternativeCourseIdentificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the course identification code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + }, + "creditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "partialCourseTranscriptAwards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "awardDate": { + "type": "string", + "format": "date", + "description": "The date the partial credits and/or grades were awarded or earned." + }, + "earnedCredits": { + "type": "number", + "description": "The number of credits a student earned for completing a given course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "letterGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + } + }, + "additionalProperties": false, + "required": [ + "awardDate", + "earnedCredits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "courseAttemptResultDescriptor", + "courseReference", + "studentAcademicRecordReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseTranscript", + "description": "This entity is the final record of a student's performance in their courses at the end of a semester or school year.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "courseAttemptResultDescriptor": { + "type": "string", + "description": "The result from the student's attempt to take the course." + }, + "attemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "earnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "earnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedAdditionalCredits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course" + }, + "additionalCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + } + }, + "additionalProperties": false, + "required": [ + "credits", + "additionalCreditTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "Student's grade level at time of course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "finalLetterGradeEarned": { + "type": "string", + "description": "The final indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "finalNumericGradeEarned": { + "type": "number", + "description": "The final indicator of student performance in a class as submitted by the instructor." + }, + "courseRepeatCodeDescriptor": { + "type": "string", + "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average." + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "studentAcademicRecordReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ] + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "externalEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "externalEducationOrganizationNameOfInstitution": { + "type": "string", + "description": "Name of the external institution where the student completed the course; to be used only when the reference external education organization is not available.", + "minLength": 1, + "maxLength": 75 + }, + "alternativeCourseIdentificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the course identification code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + }, + "creditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "partialCourseTranscriptAwards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "awardDate": { + "type": "string", + "format": "date", + "description": "The date the partial credits and/or grades were awarded or earned." + }, + "earnedCredits": { + "type": "number", + "description": "The number of credits a student earned for completing a given course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "letterGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + } + }, + "additionalProperties": false, + "required": [ + "awardDate", + "earnedCredits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "courseAttemptResultDescriptor", + "courseReference", + "studentAcademicRecordReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CourseTranscript", + "description": "This entity is the final record of a student's performance in their courses at the end of a semester or school year.", + "type": "object", + "properties": { + "courseAttemptResultDescriptor": { + "type": "string", + "description": "The result from the student's attempt to take the course." + }, + "attemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "attemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "earnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "earnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "earnedAdditionalCredits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course" + }, + "additionalCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + } + }, + "additionalProperties": false, + "required": [ + "credits", + "additionalCreditTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "Student's grade level at time of course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "finalLetterGradeEarned": { + "type": "string", + "description": "The final indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "finalNumericGradeEarned": { + "type": "number", + "description": "The final indicator of student performance in a class as submitted by the instructor." + }, + "courseRepeatCodeDescriptor": { + "type": "string", + "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average." + }, + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + }, + "studentAcademicRecordReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ] + }, + "courseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", + "minLength": 1, + "maxLength": 60 + }, + "alternativeCourseTitle": { + "type": "string", + "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", + "minLength": 1, + "maxLength": 60 + }, + "externalEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "externalEducationOrganizationNameOfInstitution": { + "type": "string", + "description": "Name of the external institution where the student completed the course; to be used only when the reference external education organization is not available.", + "minLength": 1, + "maxLength": 75 + }, + "alternativeCourseIdentificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", + "minLength": 1, + "maxLength": 60 + }, + "courseIdentificationSystemDescriptor": { + "type": "string", + "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the Identification Code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "courseIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the course identification code.", + "minLength": 1, + "maxLength": 60 + }, + "courseCatalogURL": { + "type": "string", + "description": "The URL for the course catalog that defines the course identification code.", + "minLength": 5, + "maxLength": 255 + }, + "creditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "partialCourseTranscriptAwards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "awardDate": { + "type": "string", + "format": "date", + "description": "The date the partial credits and/or grades were awarded or earned." + }, + "earnedCredits": { + "type": "number", + "description": "The number of credits a student earned for completing a given course." + }, + "methodCreditEarnedDescriptor": { + "type": "string", + "description": "The method the credits were earned." + }, + "letterGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "string", + "description": "The indicator of student performance as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + } + }, + "additionalProperties": false, + "required": [ + "awardDate", + "earnedCredits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CourseAttemptResult", + "Course", + "StudentAcademicRecord" + ], + "documentPathsMapping": { + "CourseAttemptResult": [ + "$.courseAttemptResultDescriptor" + ], + "WhenTakenGradeLevel": [ + "$.whenTakenGradeLevelDescriptor" + ], + "MethodCreditEarned": [ + "$.methodCreditEarnedDescriptor" + ], + "FinalLetterGradeEarned": [ + "$.finalLetterGradeEarned" + ], + "FinalNumericGradeEarned": [ + "$.finalNumericGradeEarned" + ], + "CourseRepeatCode": [ + "$.courseRepeatCodeDescriptor" + ], + "Course": [ + "$.courseReference.courseCode", + "$.courseReference.educationOrganizationId" + ], + "StudentAcademicRecord": [ + "$.studentAcademicRecordReference.educationOrganizationId", + "$.studentAcademicRecordReference.schoolYear", + "$.studentAcademicRecordReference.studentUniqueId", + "$.studentAcademicRecordReference.termDescriptor" + ], + "CourseTitle": [ + "$.courseTitle" + ], + "AlternativeCourseTitle": [ + "$.alternativeCourseTitle" + ], + "ExternalEducationOrganization": [ + "$.externalEducationOrganizationReference.educationOrganizationId" + ], + "ExternalEducationOrganizationNameOfInstitution": [ + "$.externalEducationOrganizationNameOfInstitution" + ], + "AssigningOrganizationIdentificationCode": [ + "$.assigningOrganizationIdentificationCode" + ], + "CourseCatalogURL": [ + "$.courseCatalogURL" + ], + "CreditCategory": [ + "$.creditCategories[*].creditCategoryDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ] + } + }, + "credentials": { + "resourceName": "Credential", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Credential", + "description": "The legal document giving authorization to perform teaching assignment services.", + "type": "object", + "properties": { + "effectiveDate": { + "type": "string", + "format": "date", + "description": "The year, month and day on which an active credential held by an individual was issued." + }, + "endorsements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "endorsement": { + "type": "string", + "description": "Endorsements are attachments to teaching certificates and indicate areas of specialization.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "endorsement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential held by an individual will expire." + }, + "credentialFieldDescriptor": { + "type": "string", + "description": "The field of certification for the certificate (e.g., Mathematics, Music)." + }, + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "issuanceDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential was issued to an individual." + }, + "credentialTypeDescriptor": { + "type": "string", + "description": "An indication of the category of credential an individual holds." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + }, + "teachingCredentialDescriptor": { + "type": "string", + "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services." + }, + "teachingCredentialBasisDescriptor": { + "type": "string", + "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the credential.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "issuanceDate", + "credentialTypeDescriptor", + "stateOfIssueStateAbbreviationDescriptor", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Credential", + "description": "The legal document giving authorization to perform teaching assignment services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "effectiveDate": { + "type": "string", + "format": "date", + "description": "The year, month and day on which an active credential held by an individual was issued." + }, + "endorsements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "endorsement": { + "type": "string", + "description": "Endorsements are attachments to teaching certificates and indicate areas of specialization.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "endorsement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential held by an individual will expire." + }, + "credentialFieldDescriptor": { + "type": "string", + "description": "The field of certification for the certificate (e.g., Mathematics, Music)." + }, + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "issuanceDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential was issued to an individual." + }, + "credentialTypeDescriptor": { + "type": "string", + "description": "An indication of the category of credential an individual holds." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + }, + "teachingCredentialDescriptor": { + "type": "string", + "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services." + }, + "teachingCredentialBasisDescriptor": { + "type": "string", + "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the credential.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "credentialIdentifier", + "issuanceDate", + "credentialTypeDescriptor", + "stateOfIssueStateAbbreviationDescriptor", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Credential", + "description": "The legal document giving authorization to perform teaching assignment services.", + "type": "object", + "properties": { + "effectiveDate": { + "type": "string", + "format": "date", + "description": "The year, month and day on which an active credential held by an individual was issued." + }, + "endorsements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "endorsement": { + "type": "string", + "description": "Endorsements are attachments to teaching certificates and indicate areas of specialization.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "endorsement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential held by an individual will expire." + }, + "credentialFieldDescriptor": { + "type": "string", + "description": "The field of certification for the certificate (e.g., Mathematics, Music)." + }, + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "issuanceDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an active credential was issued to an individual." + }, + "credentialTypeDescriptor": { + "type": "string", + "description": "An indication of the category of credential an individual holds." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + }, + "teachingCredentialDescriptor": { + "type": "string", + "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services." + }, + "teachingCredentialBasisDescriptor": { + "type": "string", + "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds." + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "namespace": { + "type": "string", + "description": "Namespace for the credential.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CredentialIdentifier", + "StateOfIssueStateAbbreviation" + ], + "documentPathsMapping": { + "EffectiveDate": [ + "$.effectiveDate" + ], + "CredentialEndorsement": [ + "$.endorsements[*].endorsement" + ], + "ExpirationDate": [ + "$.expirationDate" + ], + "CredentialField": [ + "$.credentialFieldDescriptor" + ], + "CredentialIdentifier": [ + "$.credentialIdentifier" + ], + "IssuanceDate": [ + "$.issuanceDate" + ], + "CredentialType": [ + "$.credentialTypeDescriptor" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "StateOfIssueStateAbbreviation": [ + "$.stateOfIssueStateAbbreviationDescriptor" + ], + "TeachingCredential": [ + "$.teachingCredentialDescriptor" + ], + "TeachingCredentialBasis": [ + "$.teachingCredentialBasisDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "Namespace": [ + "$.namespace" + ] + } + }, + "descriptorMappings": { + "resourceName": "DescriptorMapping", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DescriptorMapping", + "description": "A mapping of a descriptor value in one namespace to a descriptor value in another namespace. This can be used to exchange known contextual mappings of enumeration values.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The descriptor value that is being mapped to another value.", + "minLength": 1, + "maxLength": 50 + }, + "namespace": { + "type": "string", + "description": "The namespace of the descriptor value that is being mapped to another value.", + "minLength": 5, + "maxLength": 255 + }, + "mappedValue": { + "type": "string", + "description": "The descriptor value to which the from descriptor value is being mapped to.", + "minLength": 1, + "maxLength": 50 + }, + "mappedNamespace": { + "type": "string", + "description": "The namespace of the descriptor value to which the from descriptor value is mapped to.", + "minLength": 5, + "maxLength": 255 + }, + "modelEntities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "modelEntityDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "modelEntityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "value", + "namespace", + "mappedValue", + "mappedNamespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DescriptorMapping", + "description": "A mapping of a descriptor value in one namespace to a descriptor value in another namespace. This can be used to exchange known contextual mappings of enumeration values.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "value": { + "type": "string", + "description": "The descriptor value that is being mapped to another value.", + "minLength": 1, + "maxLength": 50 + }, + "namespace": { + "type": "string", + "description": "The namespace of the descriptor value that is being mapped to another value.", + "minLength": 5, + "maxLength": 255 + }, + "mappedValue": { + "type": "string", + "description": "The descriptor value to which the from descriptor value is being mapped to.", + "minLength": 1, + "maxLength": 50 + }, + "mappedNamespace": { + "type": "string", + "description": "The namespace of the descriptor value to which the from descriptor value is mapped to.", + "minLength": 5, + "maxLength": 255 + }, + "modelEntities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "modelEntityDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "modelEntityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "value", + "namespace", + "mappedValue", + "mappedNamespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DescriptorMapping", + "description": "A mapping of a descriptor value in one namespace to a descriptor value in another namespace. This can be used to exchange known contextual mappings of enumeration values.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The descriptor value that is being mapped to another value.", + "minLength": 1, + "maxLength": 50 + }, + "namespace": { + "type": "string", + "description": "The namespace of the descriptor value that is being mapped to another value.", + "minLength": 5, + "maxLength": 255 + }, + "mappedValue": { + "type": "string", + "description": "The descriptor value to which the from descriptor value is being mapped to.", + "minLength": 1, + "maxLength": 50 + }, + "mappedNamespace": { + "type": "string", + "description": "The namespace of the descriptor value to which the from descriptor value is mapped to.", + "minLength": 5, + "maxLength": 255 + }, + "modelEntities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "modelEntityDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "modelEntityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Value", + "Namespace", + "MappedValue", + "MappedNamespace" + ], + "documentPathsMapping": { + "Value": [ + "$.value" + ], + "Namespace": [ + "$.namespace" + ], + "MappedValue": [ + "$.mappedValue" + ], + "MappedNamespace": [ + "$.mappedNamespace" + ], + "ModelEntity": [ + "$.modelEntities[*].modelEntityDescriptor" + ] + } + }, + "disciplineActions": { + "resourceName": "DisciplineAction", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineAction", + "description": "This event entity represents actions taken by an education organization after a disruptive event that is recorded as a discipline incident.", + "type": "object", + "properties": { + "disciplineActionIdentifier": { + "type": "string", + "description": "Identifier assigned by the education organization to the discipline action.", + "minLength": 1, + "maxLength": 36 + }, + "disciplines": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disciplineDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disciplineDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "disciplineDate": { + "type": "string", + "format": "date", + "description": "The date of the discipline action." + }, + "disciplineActionLength": { + "type": "number", + "description": "The length of time in school days for the discipline action (e.g. removal, detention), if applicable." + }, + "actualDisciplineActionLength": { + "type": "number", + "description": "Indicates the actual length in school days of a student's disciplinary assignment." + }, + "disciplineActionLengthDifferenceReasonDescriptor": { + "type": "string", + "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment." + }, + "relatedToZeroTolerancePolicy": { + "type": "boolean", + "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "responsibilitySchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "assignmentSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "iepPlacementMeetingIndicator": { + "type": "boolean", + "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement." + }, + "studentDisciplineIncidentBehaviorAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentBehaviorAssociationReference": { + "type": "object", + "properties": { + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category." + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 36 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentBehaviorAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "disciplineActionIdentifier", + "disciplines", + "disciplineDate", + "studentReference", + "responsibilitySchoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineAction", + "description": "This event entity represents actions taken by an education organization after a disruptive event that is recorded as a discipline incident.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "disciplineActionIdentifier": { + "type": "string", + "description": "Identifier assigned by the education organization to the discipline action.", + "minLength": 1, + "maxLength": 36 + }, + "disciplines": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disciplineDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disciplineDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "disciplineDate": { + "type": "string", + "format": "date", + "description": "The date of the discipline action." + }, + "disciplineActionLength": { + "type": "number", + "description": "The length of time in school days for the discipline action (e.g. removal, detention), if applicable." + }, + "actualDisciplineActionLength": { + "type": "number", + "description": "Indicates the actual length in school days of a student's disciplinary assignment." + }, + "disciplineActionLengthDifferenceReasonDescriptor": { + "type": "string", + "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment." + }, + "relatedToZeroTolerancePolicy": { + "type": "boolean", + "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "responsibilitySchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "assignmentSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "iepPlacementMeetingIndicator": { + "type": "boolean", + "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement." + }, + "studentDisciplineIncidentBehaviorAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentBehaviorAssociationReference": { + "type": "object", + "properties": { + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category." + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 36 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentBehaviorAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "disciplineActionIdentifier", + "disciplines", + "disciplineDate", + "studentReference", + "responsibilitySchoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineAction", + "description": "This event entity represents actions taken by an education organization after a disruptive event that is recorded as a discipline incident.", + "type": "object", + "properties": { + "disciplineActionIdentifier": { + "type": "string", + "description": "Identifier assigned by the education organization to the discipline action.", + "minLength": 1, + "maxLength": 36 + }, + "disciplines": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disciplineDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disciplineDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "disciplineDate": { + "type": "string", + "format": "date", + "description": "The date of the discipline action." + }, + "disciplineActionLength": { + "type": "number", + "description": "The length of time in school days for the discipline action (e.g. removal, detention), if applicable." + }, + "actualDisciplineActionLength": { + "type": "number", + "description": "Indicates the actual length in school days of a student's disciplinary assignment." + }, + "disciplineActionLengthDifferenceReasonDescriptor": { + "type": "string", + "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment." + }, + "relatedToZeroTolerancePolicy": { + "type": "boolean", + "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "responsibilitySchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "assignmentSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "iepPlacementMeetingIndicator": { + "type": "boolean", + "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement." + }, + "studentDisciplineIncidentBehaviorAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentDisciplineIncidentBehaviorAssociationReference": { + "type": "object", + "properties": { + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category." + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 36 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentDisciplineIncidentBehaviorAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "DisciplineActionIdentifier", + "DisciplineDate", + "Student" + ], + "documentPathsMapping": { + "DisciplineActionIdentifier": [ + "$.disciplineActionIdentifier" + ], + "Discipline": [ + "$.disciplines[*].disciplineDescriptor" + ], + "DisciplineDate": [ + "$.disciplineDate" + ], + "DisciplineActionLength": [ + "$.disciplineActionLength" + ], + "ActualDisciplineActionLength": [ + "$.actualDisciplineActionLength" + ], + "DisciplineActionLengthDifferenceReason": [ + "$.disciplineActionLengthDifferenceReasonDescriptor" + ], + "RelatedToZeroTolerancePolicy": [ + "$.relatedToZeroTolerancePolicy" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Staff": [ + "$.staffs[*].staffReference.staffUniqueId" + ], + "ResponsibilitySchool": [ + "$.responsibilitySchoolReference.schoolId" + ], + "AssignmentSchool": [ + "$.assignmentSchoolReference.schoolId" + ], + "IEPPlacementMeetingIndicator": [ + "$.iepPlacementMeetingIndicator" + ], + "StudentDisciplineIncidentBehaviorAssociation": [ + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.behaviorDescriptor", + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.incidentIdentifier", + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.schoolId", + "$.studentDisciplineIncidentBehaviorAssociations[*].studentDisciplineIncidentBehaviorAssociationReference.studentUniqueId" + ] + } + }, + "disciplineIncidents": { + "resourceName": "DisciplineIncident", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineIncident", + "description": "This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.", + "type": "object", + "properties": { + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 36 + }, + "incidentDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the discipline incident occurred." + }, + "incidentTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the incident took place." + }, + "incidentLocationDescriptor": { + "type": "string", + "description": "Identifies where the discipline incident occurred and whether or not it occurred on school." + }, + "incidentDescription": { + "type": "string", + "description": "The description for an incident.", + "minLength": 1, + "maxLength": 1024 + }, + "reporterDescriptionDescriptor": { + "type": "string", + "description": "Information on the type of individual who reported the discipline incident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\")." + }, + "reporterName": { + "type": "string", + "description": "Identifies the reporter of the discipline incident by name.", + "minLength": 1, + "maxLength": 75 + }, + "behaviors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "behaviorDetailedDescription": { + "type": "string", + "description": "Specifies a more granular level of detail of a behavior involved in the incident.", + "minLength": 1, + "maxLength": 1024 + }, + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category and provides a detailed description." + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "weapons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "weaponDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "weaponDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "reportedToLawEnforcement": { + "type": "boolean", + "description": "Indicator of whether the incident was reported to law enforcement." + }, + "caseNumber": { + "type": "string", + "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", + "minLength": 1, + "maxLength": 20 + }, + "incidentCost": { + "type": "number", + "description": "The value of any quantifiable monetary loss directly resulting from the discipline incident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident." + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "externalParticipants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "disciplineIncidentParticipationCodeDescriptor": { + "type": "string", + "description": "The role or type of participation of an individual in the discipline incident." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "disciplineIncidentParticipationCodeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "incidentIdentifier", + "incidentDate", + "schoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineIncident", + "description": "This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 36 + }, + "incidentDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the discipline incident occurred." + }, + "incidentTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the incident took place." + }, + "incidentLocationDescriptor": { + "type": "string", + "description": "Identifies where the discipline incident occurred and whether or not it occurred on school." + }, + "incidentDescription": { + "type": "string", + "description": "The description for an incident.", + "minLength": 1, + "maxLength": 1024 + }, + "reporterDescriptionDescriptor": { + "type": "string", + "description": "Information on the type of individual who reported the discipline incident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\")." + }, + "reporterName": { + "type": "string", + "description": "Identifies the reporter of the discipline incident by name.", + "minLength": 1, + "maxLength": 75 + }, + "behaviors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "behaviorDetailedDescription": { + "type": "string", + "description": "Specifies a more granular level of detail of a behavior involved in the incident.", + "minLength": 1, + "maxLength": 1024 + }, + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category and provides a detailed description." + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "weapons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "weaponDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "weaponDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "reportedToLawEnforcement": { + "type": "boolean", + "description": "Indicator of whether the incident was reported to law enforcement." + }, + "caseNumber": { + "type": "string", + "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", + "minLength": 1, + "maxLength": 20 + }, + "incidentCost": { + "type": "number", + "description": "The value of any quantifiable monetary loss directly resulting from the discipline incident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident." + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "externalParticipants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "disciplineIncidentParticipationCodeDescriptor": { + "type": "string", + "description": "The role or type of participation of an individual in the discipline incident." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "disciplineIncidentParticipationCodeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "incidentIdentifier", + "incidentDate", + "schoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.DisciplineIncident", + "description": "This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.", + "type": "object", + "properties": { + "incidentIdentifier": { + "type": "string", + "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", + "minLength": 1, + "maxLength": 36 + }, + "incidentDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the discipline incident occurred." + }, + "incidentTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the incident took place." + }, + "incidentLocationDescriptor": { + "type": "string", + "description": "Identifies where the discipline incident occurred and whether or not it occurred on school." + }, + "incidentDescription": { + "type": "string", + "description": "The description for an incident.", + "minLength": 1, + "maxLength": 1024 + }, + "reporterDescriptionDescriptor": { + "type": "string", + "description": "Information on the type of individual who reported the discipline incident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\")." + }, + "reporterName": { + "type": "string", + "description": "Identifies the reporter of the discipline incident by name.", + "minLength": 1, + "maxLength": 75 + }, + "behaviors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "behaviorDetailedDescription": { + "type": "string", + "description": "Specifies a more granular level of detail of a behavior involved in the incident.", + "minLength": 1, + "maxLength": 1024 + }, + "behaviorDescriptor": { + "type": "string", + "description": "Describes behavior by category and provides a detailed description." + } + }, + "additionalProperties": false, + "required": [ + "behaviorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "weapons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "weaponDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "weaponDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "reportedToLawEnforcement": { + "type": "boolean", + "description": "Indicator of whether the incident was reported to law enforcement." + }, + "caseNumber": { + "type": "string", + "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", + "minLength": 1, + "maxLength": 20 + }, + "incidentCost": { + "type": "number", + "description": "The value of any quantifiable monetary loss directly resulting from the discipline incident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident." + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "externalParticipants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "disciplineIncidentParticipationCodeDescriptor": { + "type": "string", + "description": "The role or type of participation of an individual in the discipline incident." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "disciplineIncidentParticipationCodeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "IncidentIdentifier", + "School" + ], + "documentPathsMapping": { + "IncidentIdentifier": [ + "$.incidentIdentifier" + ], + "IncidentDate": [ + "$.incidentDate" + ], + "IncidentTime": [ + "$.incidentTime" + ], + "IncidentLocation": [ + "$.incidentLocationDescriptor" + ], + "IncidentDescription": [ + "$.incidentDescription" + ], + "ReporterDescription": [ + "$.reporterDescriptionDescriptor" + ], + "ReporterName": [ + "$.reporterName" + ], + "Weapon": [ + "$.weapons[*].weaponDescriptor" + ], + "ReportedToLawEnforcement": [ + "$.reportedToLawEnforcement" + ], + "CaseNumber": [ + "$.caseNumber" + ], + "IncidentCost": [ + "$.incidentCost" + ], + "School": [ + "$.schoolReference.schoolId" + ] + } + }, + "educationContents": { + "resourceName": "EducationContent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationContent", + "description": "This entity represents materials for students or teachers that can be used for teaching, learning, research, and more. Education content includes full courses, course materials, modules, intervention descriptions, textbooks, streaming videos, tests, software, and any other tools, materials, or techniques used to support access to knowledge.", + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + }, + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "shortDescription": { + "type": "string", + "description": "A short description or name of the entity.", + "minLength": 1, + "maxLength": 75 + }, + "description": { + "type": "string", + "description": "An extended written representation of the education content.", + "minLength": 1, + "maxLength": 1024 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The individual credited with the creation of the resource.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "additionalAuthorsIndicator": { + "type": "boolean", + "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\"." + }, + "publisher": { + "type": "string", + "description": "The organization credited with publishing the resource.", + "minLength": 1, + "maxLength": 50 + }, + "timeRequired": { + "type": "number", + "description": "Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience." + }, + "interactivityStyleDescriptor": { + "type": "string", + "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed." + }, + "contentClassDescriptor": { + "type": "string", + "description": "The predominate type or kind characterizing the learning resource." + }, + "useRightsURL": { + "type": "string", + "description": "The URL where the owner specifies permissions for using the resource.", + "minLength": 5, + "maxLength": 255 + }, + "derivativeSourceEducationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceEducationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceEducationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceLearningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceLearningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceLearningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 10 + }, + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false + }, + "cost": { + "type": "number", + "description": "An amount that has to be paid or spent to buy or obtain the education content." + }, + "costRateDescriptor": { + "type": "string", + "description": "The rate by which the cost applies." + }, + "namespace": { + "type": "string", + "description": "Namespace for the education content.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationContent", + "description": "This entity represents materials for students or teachers that can be used for teaching, learning, research, and more. Education content includes full courses, course materials, modules, intervention descriptions, textbooks, streaming videos, tests, software, and any other tools, materials, or techniques used to support access to knowledge.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + }, + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "shortDescription": { + "type": "string", + "description": "A short description or name of the entity.", + "minLength": 1, + "maxLength": 75 + }, + "description": { + "type": "string", + "description": "An extended written representation of the education content.", + "minLength": 1, + "maxLength": 1024 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The individual credited with the creation of the resource.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "additionalAuthorsIndicator": { + "type": "boolean", + "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\"." + }, + "publisher": { + "type": "string", + "description": "The organization credited with publishing the resource.", + "minLength": 1, + "maxLength": 50 + }, + "timeRequired": { + "type": "number", + "description": "Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience." + }, + "interactivityStyleDescriptor": { + "type": "string", + "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed." + }, + "contentClassDescriptor": { + "type": "string", + "description": "The predominate type or kind characterizing the learning resource." + }, + "useRightsURL": { + "type": "string", + "description": "The URL where the owner specifies permissions for using the resource.", + "minLength": 5, + "maxLength": 255 + }, + "derivativeSourceEducationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceEducationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceEducationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceLearningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceLearningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceLearningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 10 + }, + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false + }, + "cost": { + "type": "number", + "description": "An amount that has to be paid or spent to buy or obtain the education content." + }, + "costRateDescriptor": { + "type": "string", + "description": "The rate by which the cost applies." + }, + "namespace": { + "type": "string", + "description": "Namespace for the education content.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "contentIdentifier", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationContent", + "description": "This entity represents materials for students or teachers that can be used for teaching, learning, research, and more. Education content includes full courses, course materials, modules, intervention descriptions, textbooks, streaming videos, tests, software, and any other tools, materials, or techniques used to support access to knowledge.", + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + }, + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + }, + "shortDescription": { + "type": "string", + "description": "A short description or name of the entity.", + "minLength": 1, + "maxLength": 75 + }, + "description": { + "type": "string", + "description": "An extended written representation of the education content.", + "minLength": 1, + "maxLength": 1024 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The individual credited with the creation of the resource.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "additionalAuthorsIndicator": { + "type": "boolean", + "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\"." + }, + "publisher": { + "type": "string", + "description": "The organization credited with publishing the resource.", + "minLength": 1, + "maxLength": 50 + }, + "timeRequired": { + "type": "number", + "description": "Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience." + }, + "interactivityStyleDescriptor": { + "type": "string", + "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed." + }, + "contentClassDescriptor": { + "type": "string", + "description": "The predominate type or kind characterizing the learning resource." + }, + "useRightsURL": { + "type": "string", + "description": "The URL where the owner specifies permissions for using the resource.", + "minLength": 5, + "maxLength": 255 + }, + "derivativeSourceEducationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceEducationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceEducationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceLearningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceLearningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceLearningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "derivativeSourceURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "derivativeSourceURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "derivativeSourceURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 10 + }, + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false + }, + "cost": { + "type": "number", + "description": "An amount that has to be paid or spent to buy or obtain the education content." + }, + "costRateDescriptor": { + "type": "string", + "description": "The rate by which the cost applies." + }, + "namespace": { + "type": "string", + "description": "Namespace for the education content.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "ContentIdentifier" + ], + "documentPathsMapping": { + "ContentIdentifier": [ + "$.contentIdentifier" + ], + "Cost": [ + "$.cost" + ], + "CostRate": [ + "$.costRateDescriptor" + ], + "Namespace": [ + "$.namespace" + ] + } + }, + "functionDimensions": { + "resourceName": "FunctionDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.FunctionDimension", + "description": "The NCES function accounting dimension representing an expenditure. The function describes the activity for which a service or material object is acquired. The functions of a school district are generally classified into five broad areas, including instruction, support services, operation of non-instructional services, facilities acquisition and construction, and debt service.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account function dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account function dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account function dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.FunctionDimension", + "description": "The NCES function accounting dimension representing an expenditure. The function describes the activity for which a service or material object is acquired. The functions of a school district are generally classified into five broad areas, including instruction, support services, operation of non-instructional services, facilities acquisition and construction, and debt service.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account function dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account function dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account function dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.FunctionDimension", + "description": "The NCES function accounting dimension representing an expenditure. The function describes the activity for which a service or material object is acquired. The functions of a school district are generally classified into five broad areas, including instruction, support services, operation of non-instructional services, facilities acquisition and construction, and debt service.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account function dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account function dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account function dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "fundDimensions": { + "resourceName": "FundDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.FundDimension", + "description": "The NCES fund accounting dimension. A fund is a fiscal and accounting entity with a self-balancing set of accounts recording cash and other financial resources, together with all related liabilities and residual equities or balances, and changes therein, which are segregated for the purpose of carrying on specific activities or attaining certain objectives in accordance with special regulations, restrictions, or limitations.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account fund dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account fund dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account fund dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.FundDimension", + "description": "The NCES fund accounting dimension. A fund is a fiscal and accounting entity with a self-balancing set of accounts recording cash and other financial resources, together with all related liabilities and residual equities or balances, and changes therein, which are segregated for the purpose of carrying on specific activities or attaining certain objectives in accordance with special regulations, restrictions, or limitations.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account fund dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account fund dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account fund dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.FundDimension", + "description": "The NCES fund accounting dimension. A fund is a fiscal and accounting entity with a self-balancing set of accounts recording cash and other financial resources, together with all related liabilities and residual equities or balances, and changes therein, which are segregated for the purpose of carrying on specific activities or attaining certain objectives in accordance with special regulations, restrictions, or limitations.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account fund dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account fund dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account fund dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "grades": { + "resourceName": "Grade", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Grade", + "description": "This educational entity represents an overall score or assessment tied to a course over a period of time (i.e., the grading period). Student grades are usually a compilation of marks and other scores.", + "type": "object", + "properties": { + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., exam, final, grading period)." + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A conversion of the level to a standard set of performance levels." + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandardGrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A performance level that describes the student proficiency." + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "currentGradeIndicator": { + "type": "boolean", + "description": "An indicator that the posted grade is an interim grade for the grading period and not the final grade." + }, + "currentGradeAsOfDate": { + "type": "string", + "format": "date", + "description": "As-Of date for a grade posted as the current grade." + }, + "gradeEarnedDescription": { + "type": "string", + "description": "A description of the grade earned by the learner.", + "minLength": 0, + "maxLength": 64 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "studentSectionAssociationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Grade", + "description": "This educational entity represents an overall score or assessment tied to a course over a period of time (i.e., the grading period). Student grades are usually a compilation of marks and other scores.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., exam, final, grading period)." + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A conversion of the level to a standard set of performance levels." + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandardGrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A performance level that describes the student proficiency." + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "currentGradeIndicator": { + "type": "boolean", + "description": "An indicator that the posted grade is an interim grade for the grading period and not the final grade." + }, + "currentGradeAsOfDate": { + "type": "string", + "format": "date", + "description": "As-Of date for a grade posted as the current grade." + }, + "gradeEarnedDescription": { + "type": "string", + "description": "A description of the grade earned by the learner.", + "minLength": 0, + "maxLength": 64 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "gradeTypeDescriptor", + "studentSectionAssociationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Grade", + "description": "This educational entity represents an overall score or assessment tied to a course over a period of time (i.e., the grading period). Student grades are usually a compilation of marks and other scores.", + "type": "object", + "properties": { + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., exam, final, grading period)." + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A conversion of the level to a standard set of performance levels." + }, + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandardGrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance for a learning standard as submitted by the instructor." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "performanceBaseConversionDescriptor": { + "type": "string", + "description": "A performance level that describes the student proficiency." + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "currentGradeIndicator": { + "type": "boolean", + "description": "An indicator that the posted grade is an interim grade for the grading period and not the final grade." + }, + "currentGradeAsOfDate": { + "type": "string", + "format": "date", + "description": "As-Of date for a grade posted as the current grade." + }, + "gradeEarnedDescription": { + "type": "string", + "description": "A description of the grade earned by the learner.", + "minLength": 0, + "maxLength": 64 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.gradingPeriodReference.schoolId", + "targetJsonPath": "$.studentSectionAssociationReference.schoolId" + }, + { + "sourceJsonPath": "$.gradingPeriodReference.schoolYear", + "targetJsonPath": "$.studentSectionAssociationReference.schoolYear" + } + ], + "identityFullnames": [ + "GradeType", + "StudentSectionAssociation", + "GradingPeriod" + ], + "documentPathsMapping": { + "LetterGradeEarned": [ + "$.letterGradeEarned" + ], + "NumericGradeEarned": [ + "$.numericGradeEarned" + ], + "DiagnosticStatement": [ + "$.diagnosticStatement" + ], + "GradeType": [ + "$.gradeTypeDescriptor" + ], + "PerformanceBaseConversion": [ + "$.performanceBaseConversionDescriptor" + ], + "StudentSectionAssociation": [ + "$.studentSectionAssociationReference.beginDate", + "$.studentSectionAssociationReference.localCourseCode", + "$.studentSectionAssociationReference.schoolId", + "$.studentSectionAssociationReference.schoolYear", + "$.studentSectionAssociationReference.sectionIdentifier", + "$.studentSectionAssociationReference.sessionName", + "$.studentSectionAssociationReference.studentUniqueId" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ], + "CurrentGradeIndicator": [ + "$.currentGradeIndicator" + ], + "CurrentGradeAsOfDate": [ + "$.currentGradeAsOfDate" + ], + "GradeEarnedDescription": [ + "$.gradeEarnedDescription" + ] + } + }, + "gradebookEntries": { + "resourceName": "GradebookEntry", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradebookEntry", + "description": "This entity represents an assignment, homework, or classroom assessment to be recorded in a gradebook.", + "type": "object", + "properties": { + "gradebookEntryIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace URI for the source of the gradebook entry.", + "minLength": 5, + "maxLength": 255 + }, + "sourceSectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "title": { + "type": "string", + "description": "The name or title of the activity to be recorded in the gradebook entry.", + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "A description of the assignment, homework, or classroom assessment.", + "minLength": 1, + "maxLength": 1024 + }, + "dueDate": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment is due." + }, + "dueTime": { + "type": "string", + "format": "time", + "description": "The time the assignment, homework, or assessment is due." + }, + "gradebookEntryTypeDescriptor": { + "type": "string", + "description": "The type of the gradebook entry." + }, + "maxPoints": { + "type": "number", + "description": "The maximum number of points that can be earned for the submission." + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "gradebookEntryIdentifier", + "namespace", + "sourceSectionIdentifier", + "dateAssigned", + "title" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradebookEntry", + "description": "This entity represents an assignment, homework, or classroom assessment to be recorded in a gradebook.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "gradebookEntryIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace URI for the source of the gradebook entry.", + "minLength": 5, + "maxLength": 255 + }, + "sourceSectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "title": { + "type": "string", + "description": "The name or title of the activity to be recorded in the gradebook entry.", + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "A description of the assignment, homework, or classroom assessment.", + "minLength": 1, + "maxLength": 1024 + }, + "dueDate": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment is due." + }, + "dueTime": { + "type": "string", + "format": "time", + "description": "The time the assignment, homework, or assessment is due." + }, + "gradebookEntryTypeDescriptor": { + "type": "string", + "description": "The type of the gradebook entry." + }, + "maxPoints": { + "type": "number", + "description": "The maximum number of points that can be earned for the submission." + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "gradebookEntryIdentifier", + "namespace", + "sourceSectionIdentifier", + "dateAssigned", + "title" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradebookEntry", + "description": "This entity represents an assignment, homework, or classroom assessment to be recorded in a gradebook.", + "type": "object", + "properties": { + "gradebookEntryIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace URI for the source of the gradebook entry.", + "minLength": 5, + "maxLength": 255 + }, + "sourceSectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "dateAssigned": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment was assigned or executed." + }, + "title": { + "type": "string", + "description": "The name or title of the activity to be recorded in the gradebook entry.", + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "A description of the assignment, homework, or classroom assessment.", + "minLength": 1, + "maxLength": 1024 + }, + "dueDate": { + "type": "string", + "format": "date", + "description": "The date the assignment, homework, or assessment is due." + }, + "dueTime": { + "type": "string", + "format": "time", + "description": "The time the assignment, homework, or assessment is due." + }, + "gradebookEntryTypeDescriptor": { + "type": "string", + "description": "The type of the gradebook entry." + }, + "maxPoints": { + "type": "number", + "description": "The maximum number of points that can be earned for the submission." + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.gradingPeriodReference.schoolId", + "targetJsonPath": "$.sectionReference.schoolId" + }, + { + "sourceJsonPath": "$.gradingPeriodReference.schoolYear", + "targetJsonPath": "$.sectionReference.schoolYear" + } + ], + "identityFullnames": [ + "GradebookEntryIdentifier", + "Namespace" + ], + "documentPathsMapping": { + "GradebookEntryIdentifier": [ + "$.gradebookEntryIdentifier" + ], + "Namespace": [ + "$.namespace" + ], + "SourceSectionIdentifier": [ + "$.sourceSectionIdentifier" + ], + "Section": [ + "$.sectionReference.localCourseCode", + "$.sectionReference.schoolId", + "$.sectionReference.schoolYear", + "$.sectionReference.sectionIdentifier", + "$.sectionReference.sessionName" + ], + "DateAssigned": [ + "$.dateAssigned" + ], + "Title": [ + "$.title" + ], + "Description": [ + "$.description" + ], + "DueDate": [ + "$.dueDate" + ], + "DueTime": [ + "$.dueTime" + ], + "GradebookEntryType": [ + "$.gradebookEntryTypeDescriptor" + ], + "MaxPoints": [ + "$.maxPoints" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ] + } + }, + "gradingPeriods": { + "resourceName": "GradingPeriod", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradingPeriod", + "description": "This entity represents the time span for which grades are reported.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the grading period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the last day of the grading period." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "Total days available for educational instruction during the grading period.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "gradingPeriodDescriptor", + "periodSequence", + "schoolYearTypeReference", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradingPeriod", + "description": "This entity represents the time span for which grades are reported.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the grading period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the last day of the grading period." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "Total days available for educational instruction during the grading period.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "gradingPeriodDescriptor", + "periodSequence", + "schoolYearTypeReference", + "beginDate", + "endDate", + "totalInstructionalDays" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GradingPeriod", + "description": "This entity represents the time span for which grades are reported.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the grading period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the last day of the grading period." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "Total days available for educational instruction during the grading period.", + "minimum": 0 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "GradingPeriod", + "PeriodSequence", + "SchoolYear" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "GradingPeriod": [ + "$.gradingPeriodDescriptor" + ], + "PeriodSequence": [ + "$.periodSequence" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "TotalInstructionalDays": [ + "$.totalInstructionalDays" + ] + } + }, + "graduationPlans": { + "resourceName": "GraduationPlan", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GraduationPlan", + "description": "This entity is a plan outlining the required credits, credits by subject, credits by course, and other criteria required for graduation. A graduation plan may be one or more standard plans defined by an education organization and/or individual plans for some or all students.", + "type": "object", + "properties": { + "graduationPlanTypeDescriptor": { + "type": "string", + "description": "The type of academic plan the student is following for graduation." + }, + "individualPlan": { + "type": "boolean", + "description": "An indicator of whether the graduation plan is tailored for an individual." + }, + "totalRequiredCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "creditsBySubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the graduation requirement." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCourses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseSetName": { + "type": "string", + "description": "Identifying name given to a collection of courses.", + "minLength": 1, + "maxLength": 120 + }, + "courses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + } + }, + "additionalProperties": false, + "required": [ + "courseReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "The grade level when the student is planned to take the course." + } + }, + "additionalProperties": false, + "required": [ + "courseSetName", + "courses", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCreditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "A categorization for the course transcript credits awarded in the course transcript." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "graduationSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "requiredAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevel": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "graduationPlanTypeDescriptor", + "totalRequiredCredits", + "educationOrganizationReference", + "graduationSchoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GraduationPlan", + "description": "This entity is a plan outlining the required credits, credits by subject, credits by course, and other criteria required for graduation. A graduation plan may be one or more standard plans defined by an education organization and/or individual plans for some or all students.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "graduationPlanTypeDescriptor": { + "type": "string", + "description": "The type of academic plan the student is following for graduation." + }, + "individualPlan": { + "type": "boolean", + "description": "An indicator of whether the graduation plan is tailored for an individual." + }, + "totalRequiredCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "creditsBySubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the graduation requirement." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCourses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseSetName": { + "type": "string", + "description": "Identifying name given to a collection of courses.", + "minLength": 1, + "maxLength": 120 + }, + "courses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + } + }, + "additionalProperties": false, + "required": [ + "courseReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "The grade level when the student is planned to take the course." + } + }, + "additionalProperties": false, + "required": [ + "courseSetName", + "courses", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCreditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "A categorization for the course transcript credits awarded in the course transcript." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "graduationSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "requiredAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevel": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "graduationPlanTypeDescriptor", + "totalRequiredCredits", + "educationOrganizationReference", + "graduationSchoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GraduationPlan", + "description": "This entity is a plan outlining the required credits, credits by subject, credits by course, and other criteria required for graduation. A graduation plan may be one or more standard plans defined by an education organization and/or individual plans for some or all students.", + "type": "object", + "properties": { + "graduationPlanTypeDescriptor": { + "type": "string", + "description": "The type of academic plan the student is following for graduation." + }, + "individualPlan": { + "type": "boolean", + "description": "An indicator of whether the graduation plan is tailored for an individual." + }, + "totalRequiredCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "totalRequiredCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "creditsBySubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the graduation requirement." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCourses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseSetName": { + "type": "string", + "description": "Identifying name given to a collection of courses.", + "minLength": 1, + "maxLength": 120 + }, + "courses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseReference": { + "type": "object", + "properties": { + "courseCode": { + "type": "string", + "description": "A unique alphanumeric code assigned to a course.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "courseCode", + "educationOrganizationId" + ] + } + }, + "additionalProperties": false, + "required": [ + "courseReference" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "whenTakenGradeLevelDescriptor": { + "type": "string", + "description": "The grade level when the student is planned to take the course." + } + }, + "additionalProperties": false, + "required": [ + "courseSetName", + "courses", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "creditsByCreditCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "creditCategoryDescriptor": { + "type": "string", + "description": "A categorization for the course transcript credits awarded in the course transcript." + }, + "credits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "creditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "creditConversion": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + } + }, + "additionalProperties": false, + "required": [ + "creditCategoryDescriptor", + "credits" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "graduationSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "requiredAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevel": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "GraduationPlanType", + "EducationOrganization", + "GraduationSchoolYear" + ], + "documentPathsMapping": { + "GraduationPlanType": [ + "$.graduationPlanTypeDescriptor" + ], + "IndividualPlan": [ + "$.individualPlan" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "GraduationSchoolYear": [ + "$.graduationSchoolYearTypeReference.schoolYear" + ] + } + }, + "interventions": { + "resourceName": "Intervention", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Intervention", + "description": "An implementation of an instructional approach focusing on the specific techniques and materials used to teach a given subject.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented." + }, + "interventionPrescriptions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the intervention implementation." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the intervention implementation." + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that may be assigned for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that may be assigned for the intervention." + }, + "namespace": { + "type": "string", + "description": "Namespace for the intervention.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "beginDate", + "educationOrganizationReference", + "interventionIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Intervention", + "description": "An implementation of an instructional approach focusing on the specific techniques and materials used to teach a given subject.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented." + }, + "interventionPrescriptions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the intervention implementation." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the intervention implementation." + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that may be assigned for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that may be assigned for the intervention." + }, + "namespace": { + "type": "string", + "description": "Namespace for the intervention.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "beginDate", + "educationOrganizationReference", + "interventionIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Intervention", + "description": "An implementation of an instructional approach focusing on the specific techniques and materials used to teach a given subject.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented." + }, + "interventionPrescriptions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The start date for the intervention implementation." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date for the intervention implementation." + }, + "meetingTimes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time begins." + }, + "endTime": { + "type": "string", + "format": "time", + "description": "An indication of the time of day the meeting time ends." + } + }, + "additionalProperties": false, + "required": [ + "startTime", + "endTime" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "staffs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that may be assigned for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that may be assigned for the intervention." + }, + "namespace": { + "type": "string", + "description": "Namespace for the intervention.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "InterventionIdentificationCode" + ], + "documentPathsMapping": { + "InterventionClass": [ + "$.interventionClassDescriptor" + ], + "Diagnosis": [ + "$.diagnoses[*].diagnosisDescriptor" + ], + "PopulationServed": [ + "$.populationServeds[*].populationServedDescriptor" + ], + "AppropriateSex": [ + "$.appropriateSexes[*].sexDescriptor" + ], + "AppropriateGradeLevel": [ + "$.appropriateGradeLevels[*].gradeLevelDescriptor" + ], + "DeliveryMethod": [ + "$.deliveryMethodDescriptor" + ], + "InterventionPrescription": [ + "$.interventionPrescriptions[*].interventionPrescriptionReference.educationOrganizationId", + "$.interventionPrescriptions[*].interventionPrescriptionReference.interventionPrescriptionIdentificationCode" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "Staff": [ + "$.staffs[*].staffReference.staffUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "InterventionIdentificationCode": [ + "$.interventionIdentificationCode" + ], + "MinDosage": [ + "$.minDosage" + ], + "MaxDosage": [ + "$.maxDosage" + ], + "Namespace": [ + "$.namespace" + ] + } + }, + "interventionPrescriptions": { + "resourceName": "InterventionPrescription", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionPrescription", + "description": "This entity represents a formal prescription of an instructional approach focusing on the specific techniques and materials used to teach a given subject. This can be prescribed by academic research, an interventions vendor, or another entity.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that is recommended for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that is recommended for the intervention." + }, + "namespace": { + "type": "string", + "description": "Namespace for the intervention.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "educationOrganizationReference", + "interventionPrescriptionIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionPrescription", + "description": "This entity represents a formal prescription of an instructional approach focusing on the specific techniques and materials used to teach a given subject. This can be prescribed by academic research, an interventions vendor, or another entity.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that is recommended for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that is recommended for the intervention." + }, + "namespace": { + "type": "string", + "description": "Namespace for the intervention.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "interventionClassDescriptor", + "deliveryMethodDescriptor", + "educationOrganizationReference", + "interventionPrescriptionIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionPrescription", + "description": "This entity represents a formal prescription of an instructional approach focusing on the specific techniques and materials used to teach a given subject. This can be prescribed by academic research, an interventions vendor, or another entity.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false, + "required": [ + "contentIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "diagnoses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + }, + "minDosage": { + "type": "integer", + "description": "The minimum duration of time in minutes that is recommended for the intervention." + }, + "maxDosage": { + "type": "integer", + "description": "The maximum duration of time in minutes that is recommended for the intervention." + }, + "namespace": { + "type": "string", + "description": "Namespace for the intervention.", + "minLength": 5, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "InterventionPrescriptionIdentificationCode" + ], + "documentPathsMapping": { + "InterventionClass": [ + "$.interventionClassDescriptor" + ], + "Diagnosis": [ + "$.diagnoses[*].diagnosisDescriptor" + ], + "PopulationServed": [ + "$.populationServeds[*].populationServedDescriptor" + ], + "AppropriateSex": [ + "$.appropriateSexes[*].sexDescriptor" + ], + "AppropriateGradeLevel": [ + "$.appropriateGradeLevels[*].gradeLevelDescriptor" + ], + "DeliveryMethod": [ + "$.deliveryMethodDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "InterventionPrescriptionIdentificationCode": [ + "$.interventionPrescriptionIdentificationCode" + ], + "MinDosage": [ + "$.minDosage" + ], + "MaxDosage": [ + "$.maxDosage" + ], + "Namespace": [ + "$.namespace" + ] + } + }, + "interventionStudies": { + "resourceName": "InterventionStudy", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionStudy", + "description": "An experimental or quasi-experimental study of an intervention technique.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + }, + "interventionEffectivenesses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "Targeted purpose of the intervention (e.g., attendance issue, dropout risk) for which the effectiveness is measured." + }, + "populationServedDescriptor": { + "type": "string", + "description": "Population for which effectiveness is measured." + }, + "gradeLevelDescriptor": { + "type": "string", + "description": "Grade level for which effectiveness is measured." + }, + "improvementIndex": { + "type": "integer", + "description": "Along a percentile distribution of students, the improvement index represents the change in an average student's percentile rank that is considered to be due to the intervention." + }, + "interventionEffectivenessRatingDescriptor": { + "type": "string", + "description": "An intervention demonstrates effectiveness if the research has shown that the program caused an improvement in outcomes. Values: positive effects, potentially positive effects, mixed effects, potentially negative effects, negative effects, and no discernible effects." + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor", + "populationServedDescriptor", + "gradeLevelDescriptor", + "interventionEffectivenessRatingDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "participants": { + "type": "integer", + "description": "The number of participants observed in the study." + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateAbbreviations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stateAbbreviationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "stateAbbreviationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionStudyIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention study.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "interventionPrescriptionReference", + "participants", + "deliveryMethodDescriptor", + "interventionClassDescriptor", + "educationOrganizationReference", + "interventionStudyIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionStudy", + "description": "An experimental or quasi-experimental study of an intervention technique.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + }, + "interventionEffectivenesses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "Targeted purpose of the intervention (e.g., attendance issue, dropout risk) for which the effectiveness is measured." + }, + "populationServedDescriptor": { + "type": "string", + "description": "Population for which effectiveness is measured." + }, + "gradeLevelDescriptor": { + "type": "string", + "description": "Grade level for which effectiveness is measured." + }, + "improvementIndex": { + "type": "integer", + "description": "Along a percentile distribution of students, the improvement index represents the change in an average student's percentile rank that is considered to be due to the intervention." + }, + "interventionEffectivenessRatingDescriptor": { + "type": "string", + "description": "An intervention demonstrates effectiveness if the research has shown that the program caused an improvement in outcomes. Values: positive effects, potentially positive effects, mixed effects, potentially negative effects, negative effects, and no discernible effects." + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor", + "populationServedDescriptor", + "gradeLevelDescriptor", + "interventionEffectivenessRatingDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "participants": { + "type": "integer", + "description": "The number of participants observed in the study." + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateAbbreviations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stateAbbreviationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "stateAbbreviationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionStudyIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention study.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "interventionPrescriptionReference", + "participants", + "deliveryMethodDescriptor", + "interventionClassDescriptor", + "educationOrganizationReference", + "interventionStudyIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.InterventionStudy", + "description": "An experimental or quasi-experimental study of an intervention technique.", + "type": "object", + "properties": { + "educationContents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationContentReference": { + "type": "object", + "properties": { + "contentIdentifier": { + "type": "string", + "description": "A unique identifier for the education content.", + "minLength": 1, + "maxLength": 225 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "educationContentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningResourceMetadataURIs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningResourceMetadataURI": { + "type": "string", + "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "learningResourceMetadataURI" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "uris": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The URI (typical a URL) pointing to an education content item.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "uri" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "interventionPrescriptionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionPrescriptionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention prescription.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ] + }, + "interventionEffectivenesses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "diagnosisDescriptor": { + "type": "string", + "description": "Targeted purpose of the intervention (e.g., attendance issue, dropout risk) for which the effectiveness is measured." + }, + "populationServedDescriptor": { + "type": "string", + "description": "Population for which effectiveness is measured." + }, + "gradeLevelDescriptor": { + "type": "string", + "description": "Grade level for which effectiveness is measured." + }, + "improvementIndex": { + "type": "integer", + "description": "Along a percentile distribution of students, the improvement index represents the change in an average student's percentile rank that is considered to be due to the intervention." + }, + "interventionEffectivenessRatingDescriptor": { + "type": "string", + "description": "An intervention demonstrates effectiveness if the research has shown that the program caused an improvement in outcomes. Values: positive effects, potentially positive effects, mixed effects, potentially negative effects, negative effects, and no discernible effects." + } + }, + "additionalProperties": false, + "required": [ + "diagnosisDescriptor", + "populationServedDescriptor", + "gradeLevelDescriptor", + "interventionEffectivenessRatingDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "participants": { + "type": "integer", + "description": "The number of participants observed in the study." + }, + "deliveryMethodDescriptor": { + "type": "string", + "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school." + }, + "interventionClassDescriptor": { + "type": "string", + "description": "The way in which an intervention is used: curriculum, supplement, or practice." + }, + "appropriateGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "populationServeds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "populationServedDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "populationServedDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "appropriateSexes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sexDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sexDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "stateAbbreviations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stateAbbreviationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "stateAbbreviationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "interventionStudyIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention study.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "InterventionStudyIdentificationCode" + ], + "documentPathsMapping": { + "InterventionPrescription": [ + "$.interventionPrescriptionReference.educationOrganizationId", + "$.interventionPrescriptionReference.interventionPrescriptionIdentificationCode" + ], + "Participants": [ + "$.participants" + ], + "DeliveryMethod": [ + "$.deliveryMethodDescriptor" + ], + "InterventionClass": [ + "$.interventionClassDescriptor" + ], + "AppropriateGradeLevel": [ + "$.appropriateGradeLevels[*].gradeLevelDescriptor" + ], + "PopulationServed": [ + "$.populationServeds[*].populationServedDescriptor" + ], + "AppropriateSex": [ + "$.appropriateSexes[*].sexDescriptor" + ], + "StateAbbreviation": [ + "$.stateAbbreviations[*].stateAbbreviationDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "InterventionStudyIdentificationCode": [ + "$.interventionStudyIdentificationCode" + ] + } + }, + "learningStandards": { + "resourceName": "LearningStandard", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningStandard", + "description": "A statement that describes a specific competency or academic standard.", + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a Learning Standard.", + "minLength": 1, + "maxLength": 60 + }, + "contentStandardName": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 65 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "contentStandardName" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "description": { + "type": "string", + "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\".", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandardItemCode": { + "type": "string", + "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the statement using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "courseTitle": { + "type": "string", + "description": "The official course title with which this learning standard is associated.", + "minLength": 1, + "maxLength": 60 + }, + "successCriteria": { + "type": "string", + "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 learning standard.", + "minLength": 1, + "maxLength": 150 + }, + "parentLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "namespace": { + "type": "string", + "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.", + "minLength": 5, + "maxLength": 255 + }, + "learningStandardCategoryDescriptor": { + "type": "string", + "description": "An additional classification of the type of a specific learning standard." + }, + "learningStandardScopeDescriptor": { + "type": "string", + "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId", + "description", + "contentStandard", + "gradeLevels", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningStandard", + "description": "A statement that describes a specific competency or academic standard.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a Learning Standard.", + "minLength": 1, + "maxLength": 60 + }, + "contentStandardName": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 65 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "contentStandardName" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "description": { + "type": "string", + "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\".", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandardItemCode": { + "type": "string", + "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the statement using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "courseTitle": { + "type": "string", + "description": "The official course title with which this learning standard is associated.", + "minLength": 1, + "maxLength": 60 + }, + "successCriteria": { + "type": "string", + "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 learning standard.", + "minLength": 1, + "maxLength": 150 + }, + "parentLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "namespace": { + "type": "string", + "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.", + "minLength": 5, + "maxLength": 255 + }, + "learningStandardCategoryDescriptor": { + "type": "string", + "description": "An additional classification of the type of a specific learning standard." + }, + "learningStandardScopeDescriptor": { + "type": "string", + "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "learningStandardId", + "description", + "contentStandard", + "gradeLevels", + "academicSubjects", + "namespace" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LearningStandard", + "description": "A statement that describes a specific competency or academic standard.", + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a Learning Standard.", + "minLength": 1, + "maxLength": 60 + }, + "contentStandardName": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 65 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "contentStandardName" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "description": { + "type": "string", + "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\".", + "minLength": 1, + "maxLength": 1024 + }, + "learningStandardItemCode": { + "type": "string", + "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", + "minLength": 1, + "maxLength": 60 + }, + "contentStandard": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The name of the content standard, for example Common Core.", + "minLength": 1, + "maxLength": 75 + }, + "authors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "author": { + "type": "string", + "description": "The person or organization chiefly responsible for the intellectual content of the standard.", + "minLength": 1, + "maxLength": 100 + } + }, + "additionalProperties": false, + "required": [ + "author" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "version": { + "type": "string", + "description": "The version identifier for the content.", + "minLength": 1, + "maxLength": 50 + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the standards using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "publicationDate": { + "type": "string", + "format": "date", + "description": "The date on which this content was first published." + }, + "publicationYear": { + "type": "integer", + "description": "The year at which this content was first published." + }, + "publicationStatusDescriptor": { + "type": "string", + "description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown)." + }, + "mandatingEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The beginning of the period during which this learning standard document is intended for use." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end of the period during which this learning standard document is intended for use." + } + }, + "additionalProperties": false, + "required": [ + "title" + ] + }, + "uri": { + "type": "string", + "description": "An unambiguous reference to the statement using a network-resolvable URI.", + "minLength": 5, + "maxLength": 255 + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "courseTitle": { + "type": "string", + "description": "The official course title with which this learning standard is associated.", + "minLength": 1, + "maxLength": 60 + }, + "successCriteria": { + "type": "string", + "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 learning standard.", + "minLength": 1, + "maxLength": 150 + }, + "parentLearningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + }, + "namespace": { + "type": "string", + "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.", + "minLength": 5, + "maxLength": 255 + }, + "learningStandardCategoryDescriptor": { + "type": "string", + "description": "An additional classification of the type of a specific learning standard." + }, + "learningStandardScopeDescriptor": { + "type": "string", + "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LearningStandardId" + ], + "documentPathsMapping": { + "LearningStandardId": [ + "$.learningStandardId" + ], + "Description": [ + "$.description" + ], + "LearningStandardItemCode": [ + "$.learningStandardItemCode" + ], + "URI": [ + "$.uri" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "CourseTitle": [ + "$.courseTitle" + ], + "SuccessCriteria": [ + "$.successCriteria" + ], + "ParentLearningStandard": [ + "$.parentLearningStandardReference.learningStandardId" + ], + "Namespace": [ + "$.namespace" + ], + "LearningStandardCategory": [ + "$.learningStandardCategoryDescriptor" + ], + "LearningStandardScope": [ + "$.learningStandardScopeDescriptor" + ] + } + }, + "localAccounts": { + "resourceName": "LocalAccount", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalAccount", + "description": "The set of account codes defined by an education organization for a fiscal year. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "chartOfAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tagValue": { + "type": "string", + "description": "The value associated with the reporting tag.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTagDescriptor": { + "type": "string", + "description": "A descriptor used at the dimension and/or chart of account levels to demote specific state needs for reporting." + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationReference", + "fiscalYear", + "chartOfAccountReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalAccount", + "description": "The set of account codes defined by an education organization for a fiscal year. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "chartOfAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tagValue": { + "type": "string", + "description": "The value associated with the reporting tag.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTagDescriptor": { + "type": "string", + "description": "A descriptor used at the dimension and/or chart of account levels to demote specific state needs for reporting." + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "accountIdentifier", + "educationOrganizationReference", + "fiscalYear", + "chartOfAccountReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalAccount", + "description": "The set of account codes defined by an education organization for a fiscal year. It provides a formal record of the debits and credits relating to the specific account.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + }, + "accountName": { + "type": "string", + "description": "A descriptive name for the account.", + "maxLength": 100 + }, + "chartOfAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tagValue": { + "type": "string", + "description": "The value associated with the reporting tag.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTagDescriptor": { + "type": "string", + "description": "A descriptor used at the dimension and/or chart of account levels to demote specific state needs for reporting." + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.chartOfAccountReference.fiscalYear", + "targetJsonPath": "$.fiscalYear" + } + ], + "identityFullnames": [ + "AccountIdentifier", + "EducationOrganization", + "FiscalYear" + ], + "documentPathsMapping": { + "AccountIdentifier": [ + "$.accountIdentifier" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "AccountName": [ + "$.accountName" + ], + "ChartOfAccount": [ + "$.chartOfAccountReference.accountIdentifier", + "$.chartOfAccountReference.educationOrganizationId", + "$.chartOfAccountReference.fiscalYear" + ] + } + }, + "localActuals": { + "resourceName": "LocalActual", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalActual", + "description": "The set of local education agency or charter management organization expense or revenue amounts.", + "type": "object", + "properties": { + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalActual", + "description": "The set of local education agency or charter management organization expense or revenue amounts.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalActual", + "description": "The set of local education agency or charter management organization expense or revenue amounts.", + "type": "object", + "properties": { + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LocalAccount", + "AsOfDate" + ], + "documentPathsMapping": { + "LocalAccount": [ + "$.localAccountReference.accountIdentifier", + "$.localAccountReference.educationOrganizationId", + "$.localAccountReference.fiscalYear" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Amount": [ + "$.amount" + ], + "FinancialCollection": [ + "$.financialCollectionDescriptor" + ] + } + }, + "localBudgets": { + "resourceName": "LocalBudget", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalBudget", + "description": "The set of local education agency or charter management organization budget amounts.", + "type": "object", + "properties": { + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalBudget", + "description": "The set of local education agency or charter management organization budget amounts.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalBudget", + "description": "The set of local education agency or charter management organization budget amounts.", + "type": "object", + "properties": { + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LocalAccount", + "AsOfDate" + ], + "documentPathsMapping": { + "LocalAccount": [ + "$.localAccountReference.accountIdentifier", + "$.localAccountReference.educationOrganizationId", + "$.localAccountReference.fiscalYear" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Amount": [ + "$.amount" + ], + "FinancialCollection": [ + "$.financialCollectionDescriptor" + ] + } + }, + "localContractedStaffs": { + "resourceName": "LocalContractedStaff", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalContractedStaff", + "description": "The set of local education agency or charter management organization contracted staff amounts.", + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "staffReference", + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalContractedStaff", + "description": "The set of local education agency or charter management organization contracted staff amounts.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "staffReference", + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalContractedStaff", + "description": "The set of local education agency or charter management organization contracted staff amounts.", + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Staff", + "LocalAccount", + "AsOfDate" + ], + "documentPathsMapping": { + "Staff": [ + "$.staffReference.staffUniqueId" + ], + "LocalAccount": [ + "$.localAccountReference.accountIdentifier", + "$.localAccountReference.educationOrganizationId", + "$.localAccountReference.fiscalYear" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Amount": [ + "$.amount" + ], + "FinancialCollection": [ + "$.financialCollectionDescriptor" + ] + } + }, + "localEncumbrances": { + "resourceName": "LocalEncumbrance", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEncumbrance", + "description": "The set of local education agency or charter management organization encumbrance amounts.", + "type": "object", + "properties": { + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEncumbrance", + "description": "The set of local education agency or charter management organization encumbrance amounts.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEncumbrance", + "description": "The set of local education agency or charter management organization encumbrance amounts.", + "type": "object", + "properties": { + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LocalAccount", + "AsOfDate" + ], + "documentPathsMapping": { + "LocalAccount": [ + "$.localAccountReference.accountIdentifier", + "$.localAccountReference.educationOrganizationId", + "$.localAccountReference.fiscalYear" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Amount": [ + "$.amount" + ], + "FinancialCollection": [ + "$.financialCollectionDescriptor" + ] + } + }, + "localPayrolls": { + "resourceName": "LocalPayroll", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalPayroll", + "description": "The set of local education agency or charter management organization payroll amounts.", + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "staffReference", + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalPayroll", + "description": "The set of local education agency or charter management organization payroll amounts.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "staffReference", + "localAccountReference", + "asOfDate", + "amount" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalPayroll", + "description": "The set of local education agency or charter management organization payroll amounts.", + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "localAccountReference": { + "type": "object", + "properties": { + "accountIdentifier": { + "type": "string", + "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported. ", + "minLength": 1, + "maxLength": 50 + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for the account.", + "minimum": 2020, + "maximum": 2040 + } + }, + "additionalProperties": false, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ] + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The date of the reported amount for the account." + }, + "amount": { + "type": "number", + "description": "Current balance for the account." + }, + "financialCollectionDescriptor": { + "type": "string", + "description": "The accounting period or grouping for which the amount is collected." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Staff", + "LocalAccount", + "AsOfDate" + ], + "documentPathsMapping": { + "Staff": [ + "$.staffReference.staffUniqueId" + ], + "LocalAccount": [ + "$.localAccountReference.accountIdentifier", + "$.localAccountReference.educationOrganizationId", + "$.localAccountReference.fiscalYear" + ], + "AsOfDate": [ + "$.asOfDate" + ], + "Amount": [ + "$.amount" + ], + "FinancialCollection": [ + "$.financialCollectionDescriptor" + ] + } + }, + "locations": { + "resourceName": "Location", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Location", + "description": "This entity represents the physical space where students gather for a particular class/section. The location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maximumNumberOfSeats": { + "type": "integer", + "description": "The most number of seats the class can maintain." + }, + "optimalNumberOfSeats": { + "type": "integer", + "description": "The number of seats that is most favorable to the class." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolReference", + "classroomIdentificationCode" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Location", + "description": "This entity represents the physical space where students gather for a particular class/section. The location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maximumNumberOfSeats": { + "type": "integer", + "description": "The most number of seats the class can maintain." + }, + "optimalNumberOfSeats": { + "type": "integer", + "description": "The number of seats that is most favorable to the class." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolReference", + "classroomIdentificationCode" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Location", + "description": "This entity represents the physical space where students gather for a particular class/section. The location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.", + "type": "object", + "properties": { + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maximumNumberOfSeats": { + "type": "integer", + "description": "The most number of seats the class can maintain." + }, + "optimalNumberOfSeats": { + "type": "integer", + "description": "The number of seats that is most favorable to the class." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "School", + "ClassroomIdentificationCode" + ], + "documentPathsMapping": { + "School": [ + "$.schoolReference.schoolId" + ], + "ClassroomIdentificationCode": [ + "$.classroomIdentificationCode" + ], + "MaximumNumberOfSeats": [ + "$.maximumNumberOfSeats" + ], + "OptimalNumberOfSeats": [ + "$.optimalNumberOfSeats" + ] + } + }, + "objectDimensions": { + "resourceName": "ObjectDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectDimension", + "description": "The NCES object accounting dimension representing an expenditure. Per the NCES definition, this classification is used to describe the service or commodity obtained as the result of a specific expenditure, such as salaries, benefits, tuition reimbursement, and so forth.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account object dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account object dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account object dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectDimension", + "description": "The NCES object accounting dimension representing an expenditure. Per the NCES definition, this classification is used to describe the service or commodity obtained as the result of a specific expenditure, such as salaries, benefits, tuition reimbursement, and so forth.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account object dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account object dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account object dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectDimension", + "description": "The NCES object accounting dimension representing an expenditure. Per the NCES definition, this classification is used to describe the service or commodity obtained as the result of a specific expenditure, such as salaries, benefits, tuition reimbursement, and so forth.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account object dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account object dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account object dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "objectiveAssessments": { + "resourceName": "ObjectiveAssessment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectiveAssessment", + "description": "This entity represents subtests that assess specific learning objectives.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "percentOfAssessment": { + "type": "number", + "description": "The percentage of the assessment that tests this objective." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for this level of objective assessment.", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The description of the objective assessment (e.g., vocabulary, measurement, or geometry).", + "minLength": 1, + "maxLength": 1024 + }, + "assessmentItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentObjectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The subject area of the objective assessment." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectiveAssessment", + "description": "This entity represents subtests that assess specific learning objectives.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "percentOfAssessment": { + "type": "number", + "description": "The percentage of the assessment that tests this objective." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for this level of objective assessment.", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The description of the objective assessment (e.g., vocabulary, measurement, or geometry).", + "minLength": 1, + "maxLength": 1024 + }, + "assessmentItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentObjectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The subject area of the objective assessment." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "identificationCode", + "assessmentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ObjectiveAssessment", + "description": "This entity represents subtests that assess specific learning objectives.", + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "maxRawScore": { + "type": "number", + "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "The performance level(s) defined for the assessment." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score required to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score to make the indicated level of performance.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "percentOfAssessment": { + "type": "number", + "description": "The percentage of the assessment that tests this objective." + }, + "nomenclature": { + "type": "string", + "description": "Reflects the specific nomenclature used for this level of objective assessment.", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The description of the objective assessment (e.g., vocabulary, measurement, or geometry).", + "minLength": 1, + "maxLength": 1024 + }, + "assessmentItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentObjectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "scores": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "minimumScore": { + "type": "string", + "description": "The minimum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "maximumScore": { + "type": "string", + "description": "The maximum score possible on the assessment.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + } + }, + "additionalProperties": false, + "required": [ + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The subject area of the objective assessment." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.assessmentItems[*].assessmentItemReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.assessmentItems[*].assessmentItemReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + }, + { + "sourceJsonPath": "$.parentObjectiveAssessmentReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.parentObjectiveAssessmentReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + } + ], + "identityFullnames": [ + "IdentificationCode", + "Assessment" + ], + "documentPathsMapping": { + "IdentificationCode": [ + "$.identificationCode" + ], + "MaxRawScore": [ + "$.maxRawScore" + ], + "PercentOfAssessment": [ + "$.percentOfAssessment" + ], + "Nomenclature": [ + "$.nomenclature" + ], + "Description": [ + "$.description" + ], + "AssessmentItem": [ + "$.assessmentItems[*].assessmentItemReference.assessmentIdentifier", + "$.assessmentItems[*].assessmentItemReference.identificationCode", + "$.assessmentItems[*].assessmentItemReference.namespace" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ], + "ParentObjectiveAssessment": [ + "$.parentObjectiveAssessmentReference.assessmentIdentifier", + "$.parentObjectiveAssessmentReference.identificationCode", + "$.parentObjectiveAssessmentReference.namespace" + ], + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ] + } + }, + "openStaffPositions": { + "resourceName": "OpenStaffPosition", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OpenStaffPosition", + "description": "This entity represents an open staff position that the education organization is seeking to fill.", + "type": "object", + "properties": { + "employmentStatusDescriptor": { + "type": "string", + "description": "Reflects the type of employment or contract desired for the position." + }, + "staffClassificationDescriptor": { + "type": "string", + "description": "The titles of employment, official status, or rank of education staff." + }, + "positionTitle": { + "type": "string", + "description": "The descriptive name of an individual's position.", + "minLength": 1, + "maxLength": 100 + }, + "requisitionNumber": { + "type": "string", + "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", + "minLength": 1, + "maxLength": 20 + }, + "programAssignmentDescriptor": { + "type": "string", + "description": "The name of the program for which the open staff position will be assigned." + }, + "instructionalGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "datePosted": { + "type": "string", + "format": "date", + "description": "Date the open staff position was posted." + }, + "datePostingRemoved": { + "type": "string", + "format": "date", + "description": "The date the posting was removed or filled." + }, + "postingResultDescriptor": { + "type": "string", + "description": "Indication of whether the OpenStaffPosition was filled or retired without filling." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "employmentStatusDescriptor", + "staffClassificationDescriptor", + "requisitionNumber", + "datePosted", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OpenStaffPosition", + "description": "This entity represents an open staff position that the education organization is seeking to fill.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "employmentStatusDescriptor": { + "type": "string", + "description": "Reflects the type of employment or contract desired for the position." + }, + "staffClassificationDescriptor": { + "type": "string", + "description": "The titles of employment, official status, or rank of education staff." + }, + "positionTitle": { + "type": "string", + "description": "The descriptive name of an individual's position.", + "minLength": 1, + "maxLength": 100 + }, + "requisitionNumber": { + "type": "string", + "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", + "minLength": 1, + "maxLength": 20 + }, + "programAssignmentDescriptor": { + "type": "string", + "description": "The name of the program for which the open staff position will be assigned." + }, + "instructionalGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "datePosted": { + "type": "string", + "format": "date", + "description": "Date the open staff position was posted." + }, + "datePostingRemoved": { + "type": "string", + "format": "date", + "description": "The date the posting was removed or filled." + }, + "postingResultDescriptor": { + "type": "string", + "description": "Indication of whether the OpenStaffPosition was filled or retired without filling." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "employmentStatusDescriptor", + "staffClassificationDescriptor", + "requisitionNumber", + "datePosted", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OpenStaffPosition", + "description": "This entity represents an open staff position that the education organization is seeking to fill.", + "type": "object", + "properties": { + "employmentStatusDescriptor": { + "type": "string", + "description": "Reflects the type of employment or contract desired for the position." + }, + "staffClassificationDescriptor": { + "type": "string", + "description": "The titles of employment, official status, or rank of education staff." + }, + "positionTitle": { + "type": "string", + "description": "The descriptive name of an individual's position.", + "minLength": 1, + "maxLength": 100 + }, + "requisitionNumber": { + "type": "string", + "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", + "minLength": 1, + "maxLength": 20 + }, + "programAssignmentDescriptor": { + "type": "string", + "description": "The name of the program for which the open staff position will be assigned." + }, + "instructionalGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicSubjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicSubjectDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "academicSubjectDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "datePosted": { + "type": "string", + "format": "date", + "description": "Date the open staff position was posted." + }, + "datePostingRemoved": { + "type": "string", + "format": "date", + "description": "The date the posting was removed or filled." + }, + "postingResultDescriptor": { + "type": "string", + "description": "Indication of whether the OpenStaffPosition was filled or retired without filling." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "RequisitionNumber", + "EducationOrganization" + ], + "documentPathsMapping": { + "EmploymentStatus": [ + "$.employmentStatusDescriptor" + ], + "StaffClassification": [ + "$.staffClassificationDescriptor" + ], + "PositionTitle": [ + "$.positionTitle" + ], + "RequisitionNumber": [ + "$.requisitionNumber" + ], + "ProgramAssignment": [ + "$.programAssignmentDescriptor" + ], + "InstructionalGradeLevel": [ + "$.instructionalGradeLevels[*].gradeLevelDescriptor" + ], + "AcademicSubject": [ + "$.academicSubjects[*].academicSubjectDescriptor" + ], + "DatePosted": [ + "$.datePosted" + ], + "DatePostingRemoved": [ + "$.datePostingRemoved" + ], + "PostingResult": [ + "$.postingResultDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ] + } + }, + "operationalUnitDimensions": { + "resourceName": "OperationalUnitDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OperationalUnitDimension", + "description": "The NCES operational unit accounting dimension. This dimension is used to segregate costs by school and operational unit such as physical location, department, or other method.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account operational unit dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account operational unit dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account operational unit dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OperationalUnitDimension", + "description": "The NCES operational unit accounting dimension. This dimension is used to segregate costs by school and operational unit such as physical location, department, or other method.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account operational unit dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account operational unit dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account operational unit dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OperationalUnitDimension", + "description": "The NCES operational unit accounting dimension. This dimension is used to segregate costs by school and operational unit such as physical location, department, or other method.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account operational unit dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account operational unit dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account operational unit dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "people": { + "resourceName": "Person", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Person", + "description": "This entity represents a human being.", + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Person", + "description": "This entity represents a human being.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "personId", + "sourceSystemDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Person", + "description": "This entity represents a human being.", + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "PersonId", + "SourceSystem" + ], + "documentPathsMapping": { + "PersonId": [ + "$.personId" + ], + "SourceSystem": [ + "$.sourceSystemDescriptor" + ] + } + }, + "postSecondaryEvents": { + "resourceName": "PostSecondaryEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryEvent", + "description": "This entity captures significant postsecondary events during a student's high school tenure (e.g., FAFSA application or college application, acceptance, and enrollment) or during a student's enrollment at a post-secondary institution.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the event occurred or was recorded." + }, + "postSecondaryEventCategoryDescriptor": { + "type": "string", + "description": "The post secondary event that is logged." + }, + "postSecondaryInstitutionReference": { + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryEvent", + "description": "This entity captures significant postsecondary events during a student's high school tenure (e.g., FAFSA application or college application, acceptance, and enrollment) or during a student's enrollment at a post-secondary institution.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the event occurred or was recorded." + }, + "postSecondaryEventCategoryDescriptor": { + "type": "string", + "description": "The post secondary event that is logged." + }, + "postSecondaryInstitutionReference": { + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryEvent", + "description": "This entity captures significant postsecondary events during a student's high school tenure (e.g., FAFSA application or college application, acceptance, and enrollment) or during a student's enrollment at a post-secondary institution.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the event occurred or was recorded." + }, + "postSecondaryEventCategoryDescriptor": { + "type": "string", + "description": "The post secondary event that is logged." + }, + "postSecondaryInstitutionReference": { + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EventDate", + "PostSecondaryEventCategory", + "Student" + ], + "documentPathsMapping": { + "EventDate": [ + "$.eventDate" + ], + "PostSecondaryEventCategory": [ + "$.postSecondaryEventCategoryDescriptor" + ], + "PostSecondaryInstitution": [ + "$.postSecondaryInstitutionReference.postSecondaryInstitutionId" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ] + } + }, + "programs": { + "resourceName": "Program", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Program", + "description": "This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services, or benefits through federal, state, or local agencies. Programs may also include organized extracurricular activities for students.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sponsors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programSponsorDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programSponsorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationReference", + "programName", + "programTypeDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Program", + "description": "This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services, or benefits through federal, state, or local agencies. Programs may also include organized extracurricular activities for students.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sponsors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programSponsorDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programSponsorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationOrganizationReference", + "programName", + "programTypeDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Program", + "description": "This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services, or benefits through federal, state, or local agencies. Programs may also include organized extracurricular activities for students.", + "type": "object", + "properties": { + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programId": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 20 + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sponsors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programSponsorDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "programSponsorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "learningStandards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "learningStandardReference": { + "type": "object", + "properties": { + "learningStandardId": { + "type": "string", + "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "learningStandardId" + ] + } + }, + "additionalProperties": false, + "required": [ + "learningStandardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganization", + "ProgramName", + "ProgramType" + ], + "documentPathsMapping": { + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ProgramId": [ + "$.programId" + ], + "ProgramName": [ + "$.programName" + ], + "ProgramType": [ + "$.programTypeDescriptor" + ], + "ProgramCharacteristic": [ + "$.characteristics[*].programCharacteristicDescriptor" + ], + "ProgramSponsor": [ + "$.sponsors[*].programSponsorDescriptor" + ], + "LearningStandard": [ + "$.learningStandards[*].learningStandardReference.learningStandardId" + ] + } + }, + "programDimensions": { + "resourceName": "ProgramDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ProgramDimension", + "description": "The NCES program accounting dimension. A program is defined by the NCES as a plan of activities and procedures designed to accomplish a predetermined objective or set of objectives. These are often categorized into broad program areas such as regular education, special education, vocational education, other PK-12 instructional, nonpublic school, adult and continuing education, community and junior college education, community services, and co-curricular or extracurricular activities.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account program dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account program dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account program dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ProgramDimension", + "description": "The NCES program accounting dimension. A program is defined by the NCES as a plan of activities and procedures designed to accomplish a predetermined objective or set of objectives. These are often categorized into broad program areas such as regular education, special education, vocational education, other PK-12 instructional, nonpublic school, adult and continuing education, community and junior college education, community services, and co-curricular or extracurricular activities.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account program dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account program dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account program dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ProgramDimension", + "description": "The NCES program accounting dimension. A program is defined by the NCES as a plan of activities and procedures designed to accomplish a predetermined objective or set of objectives. These are often categorized into broad program areas such as regular education, special education, vocational education, other PK-12 instructional, nonpublic school, adult and continuing education, community and junior college education, community services, and co-curricular or extracurricular activities.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account program dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account program dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account program dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "projectDimensions": { + "resourceName": "ProjectDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ProjectDimension", + "description": "The NCES project accounting dimension. The project dimension reporting code permits school districts to accumulate expenditures to meet a variety of specialized reporting requirements at the local, state, and federal levels.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account project dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account project dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account project dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ProjectDimension", + "description": "The NCES project accounting dimension. The project dimension reporting code permits school districts to accumulate expenditures to meet a variety of specialized reporting requirements at the local, state, and federal levels.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account project dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account project dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account project dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ProjectDimension", + "description": "The NCES project accounting dimension. The project dimension reporting code permits school districts to accumulate expenditures to meet a variety of specialized reporting requirements at the local, state, and federal levels.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account project dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account project dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account project dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "reportCards": { + "resourceName": "ReportCard", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ReportCard", + "description": "This educational entity represents the collection of student grades for courses taken during a grading period.", + "type": "object", + "properties": { + "grades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeReference": { + "type": "object", + "properties": { + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., exam, final, grading period)." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "beginDate", + "localCourseCode", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentCompetencyObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentCompetencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentCompetencyObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "numberOfDaysAbsent": { + "type": "number", + "description": "The number of days an individual is absent when school is in session during a given reporting period." + }, + "numberOfDaysInAttendance": { + "type": "number", + "description": "The number of days an individual is present when school is in session during a given reporting period." + }, + "numberOfDaysTardy": { + "type": "integer", + "description": "The number of days an individual is tardy during a given reporting period.", + "minimum": 0 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "educationOrganizationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ReportCard", + "description": "This educational entity represents the collection of student grades for courses taken during a grading period.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "grades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeReference": { + "type": "object", + "properties": { + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., exam, final, grading period)." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "beginDate", + "localCourseCode", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentCompetencyObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentCompetencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentCompetencyObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "numberOfDaysAbsent": { + "type": "number", + "description": "The number of days an individual is absent when school is in session during a given reporting period." + }, + "numberOfDaysInAttendance": { + "type": "number", + "description": "The number of days an individual is present when school is in session during a given reporting period." + }, + "numberOfDaysTardy": { + "type": "integer", + "description": "The number of days an individual is tardy during a given reporting period.", + "minimum": 0 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "educationOrganizationReference", + "gradingPeriodReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.ReportCard", + "description": "This educational entity represents the collection of student grades for courses taken during a grading period.", + "type": "object", + "properties": { + "grades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeReference": { + "type": "object", + "properties": { + "gradeTypeDescriptor": { + "type": "string", + "description": "The type of grade reported (e.g., exam, final, grading period)." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "beginDate", + "localCourseCode", + "sessionName", + "sectionIdentifier", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentCompetencyObjectives": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentCompetencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "studentCompetencyObjectiveReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "numberOfDaysAbsent": { + "type": "number", + "description": "The number of days an individual is absent when school is in session during a given reporting period." + }, + "numberOfDaysInAttendance": { + "type": "number", + "description": "The number of days an individual is present when school is in session during a given reporting period." + }, + "numberOfDaysTardy": { + "type": "integer", + "description": "The number of days an individual is tardy during a given reporting period.", + "minimum": 0 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.grades[*].gradeReference.gradingPeriodDescriptor", + "targetJsonPath": "$.gradingPeriodReference.gradingPeriodDescriptor" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.periodSequence", + "targetJsonPath": "$.gradingPeriodReference.periodSequence" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.schoolId", + "targetJsonPath": "$.gradingPeriodReference.schoolId" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.schoolYear", + "targetJsonPath": "$.gradingPeriodReference.schoolYear" + }, + { + "sourceJsonPath": "$.grades[*].gradeReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.gradingPeriodDescriptor", + "targetJsonPath": "$.gradingPeriodReference.gradingPeriodDescriptor" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.periodSequence", + "targetJsonPath": "$.gradingPeriodReference.periodSequence" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolId", + "targetJsonPath": "$.gradingPeriodReference.schoolId" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolYear", + "targetJsonPath": "$.gradingPeriodReference.schoolYear" + }, + { + "sourceJsonPath": "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "Student", + "EducationOrganization", + "GradingPeriod" + ], + "documentPathsMapping": { + "Grade": [ + "$.grades[*].gradeReference.beginDate", + "$.grades[*].gradeReference.gradeTypeDescriptor", + "$.grades[*].gradeReference.gradingPeriodDescriptor", + "$.grades[*].gradeReference.localCourseCode", + "$.grades[*].gradeReference.periodSequence", + "$.grades[*].gradeReference.schoolId", + "$.grades[*].gradeReference.schoolYear", + "$.grades[*].gradeReference.sectionIdentifier", + "$.grades[*].gradeReference.sessionName", + "$.grades[*].gradeReference.studentUniqueId" + ], + "StudentCompetencyObjective": [ + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.educationOrganizationId", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.gradingPeriodDescriptor", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.objective", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.objectiveGradeLevelDescriptor", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.periodSequence", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolId", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.schoolYear", + "$.studentCompetencyObjectives[*].studentCompetencyObjectiveReference.studentUniqueId" + ], + "NumberOfDaysAbsent": [ + "$.numberOfDaysAbsent" + ], + "NumberOfDaysInAttendance": [ + "$.numberOfDaysInAttendance" + ], + "NumberOfDaysTardy": [ + "$.numberOfDaysTardy" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ] + } + }, + "restraintEvents": { + "resourceName": "RestraintEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.RestraintEvent", + "description": "This event entity represents the instances where a special education student was physically or mechanically restrained due to imminent serious physical harm to themselves or others, imminent serious property destruction or a combination of both imminent serious physical harm to themselves or others and imminent serious property destruction.", + "type": "object", + "properties": { + "restraintEventIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a restraint event by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 36 + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the restraint event." + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting where the RestraintEvent was exercised." + }, + "reasons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "restraintEventReasonDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "restraintEventReasonDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "restraintEventIdentifier", + "eventDate", + "studentReference", + "schoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.RestraintEvent", + "description": "This event entity represents the instances where a special education student was physically or mechanically restrained due to imminent serious physical harm to themselves or others, imminent serious property destruction or a combination of both imminent serious physical harm to themselves or others and imminent serious property destruction.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "restraintEventIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a restraint event by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 36 + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the restraint event." + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting where the RestraintEvent was exercised." + }, + "reasons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "restraintEventReasonDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "restraintEventReasonDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "restraintEventIdentifier", + "eventDate", + "studentReference", + "schoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.RestraintEvent", + "description": "This event entity represents the instances where a special education student was physically or mechanically restrained due to imminent serious physical harm to themselves or others, imminent serious property destruction or a combination of both imminent serious physical harm to themselves or others and imminent serious property destruction.", + "type": "object", + "properties": { + "restraintEventIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a restraint event by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 36 + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the restraint event." + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting where the RestraintEvent was exercised." + }, + "reasons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "restraintEventReasonDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "restraintEventReasonDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "RestraintEventIdentifier", + "Student", + "School" + ], + "documentPathsMapping": { + "RestraintEventIdentifier": [ + "$.restraintEventIdentifier" + ], + "EventDate": [ + "$.eventDate" + ], + "EducationalEnvironment": [ + "$.educationalEnvironmentDescriptor" + ], + "RestraintEventReason": [ + "$.reasons[*].restraintEventReasonDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programs[*].programReference.educationOrganizationId", + "$.programs[*].programReference.programName", + "$.programs[*].programReference.programTypeDescriptor" + ], + "School": [ + "$.schoolReference.schoolId" + ] + } + }, + "sections": { + "resourceName": "Section", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Section", + "description": "This entity represents a setting in which organized instruction of course content is provided, in-person or otherwise, to one or more students for a given period of time. A course offering may be offered to more than one section.", + "type": "object", + "properties": { + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sequenceOfCourse": { + "type": "integer", + "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.", + "minimum": 1, + "maximum": 8 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a student receives education and related services." + }, + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "The media through which teachers provide instruction to students and students and teachers communicate about instructional matters." + }, + "populationServedDescriptor": { + "type": "string", + "description": "The type of students the section is offered and tailored to." + }, + "availableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "availableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "availableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sectionCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "instructionLanguageDescriptor": { + "type": "string", + "description": "The primary language of instruction. If omitted, English is assumed." + }, + "courseOfferingReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "locationSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "locationReference": { + "type": "object", + "properties": { + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classroomIdentificationCode", + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this section is used for official daily attendance. Alternatively, official daily attendance may be tied to a class period." + }, + "sectionName": { + "type": "string", + "description": "A locally-defined name for the section, generally created to make the section more recognizable in informal contexts and generally distinct from the section identifier.", + "minLength": 1, + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "sectionIdentifier", + "courseOfferingReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Section", + "description": "This entity represents a setting in which organized instruction of course content is provided, in-person or otherwise, to one or more students for a given period of time. A course offering may be offered to more than one section.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sequenceOfCourse": { + "type": "integer", + "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.", + "minimum": 1, + "maximum": 8 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a student receives education and related services." + }, + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "The media through which teachers provide instruction to students and students and teachers communicate about instructional matters." + }, + "populationServedDescriptor": { + "type": "string", + "description": "The type of students the section is offered and tailored to." + }, + "availableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "availableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "availableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sectionCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "instructionLanguageDescriptor": { + "type": "string", + "description": "The primary language of instruction. If omitted, English is assumed." + }, + "courseOfferingReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "locationSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "locationReference": { + "type": "object", + "properties": { + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classroomIdentificationCode", + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this section is used for official daily attendance. Alternatively, official daily attendance may be tied to a class period." + }, + "sectionName": { + "type": "string", + "description": "A locally-defined name for the section, generally created to make the section more recognizable in informal contexts and generally distinct from the section identifier.", + "minLength": 1, + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "sectionIdentifier", + "courseOfferingReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Section", + "description": "This entity represents a setting in which organized instruction of course content is provided, in-person or otherwise, to one or more students for a given period of time. A course offering may be offered to more than one section.", + "type": "object", + "properties": { + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "sequenceOfCourse": { + "type": "integer", + "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.", + "minimum": 1, + "maximum": 8 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a student receives education and related services." + }, + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "The media through which teachers provide instruction to students and students and teachers communicate about instructional matters." + }, + "populationServedDescriptor": { + "type": "string", + "description": "The type of students the section is offered and tailored to." + }, + "availableCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "availableCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "availableCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "characteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sectionCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "sectionCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "instructionLanguageDescriptor": { + "type": "string", + "description": "The primary language of instruction. If omitted, English is assumed." + }, + "courseOfferingReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "locationSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "locationReference": { + "type": "object", + "properties": { + "classroomIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classroomIdentificationCode", + "schoolId" + ] + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "programs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "programReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "courseLevelCharacteristics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courseLevelCharacteristicDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "courseLevelCharacteristicDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "offeredGradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "officialAttendancePeriod": { + "type": "boolean", + "description": "Indicator of whether this section is used for official daily attendance. Alternatively, official daily attendance may be tied to a class period." + }, + "sectionName": { + "type": "string", + "description": "A locally-defined name for the section, generally created to make the section more recognizable in informal contexts and generally distinct from the section identifier.", + "minLength": 1, + "maxLength": 100 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.classPeriods[*].classPeriodReference.schoolId", + "targetJsonPath": "$.courseOfferingReference.schoolId" + } + ], + "identityFullnames": [ + "SectionIdentifier", + "CourseOffering" + ], + "documentPathsMapping": { + "SectionIdentifier": [ + "$.sectionIdentifier" + ], + "SequenceOfCourse": [ + "$.sequenceOfCourse" + ], + "EducationalEnvironment": [ + "$.educationalEnvironmentDescriptor" + ], + "MediumOfInstruction": [ + "$.mediumOfInstructionDescriptor" + ], + "PopulationServed": [ + "$.populationServedDescriptor" + ], + "SectionCharacteristic": [ + "$.characteristics[*].sectionCharacteristicDescriptor" + ], + "InstructionLanguage": [ + "$.instructionLanguageDescriptor" + ], + "CourseOffering": [ + "$.courseOfferingReference.localCourseCode", + "$.courseOfferingReference.schoolId", + "$.courseOfferingReference.schoolYear", + "$.courseOfferingReference.sessionName" + ], + "LocationSchool": [ + "$.locationSchoolReference.schoolId" + ], + "Location": [ + "$.locationReference.classroomIdentificationCode", + "$.locationReference.schoolId" + ], + "ClassPeriod": [ + "$.classPeriods[*].classPeriodReference.classPeriodName", + "$.classPeriods[*].classPeriodReference.schoolId" + ], + "Program": [ + "$.programs[*].programReference.educationOrganizationId", + "$.programs[*].programReference.programName", + "$.programs[*].programReference.programTypeDescriptor" + ], + "CourseLevelCharacteristic": [ + "$.courseLevelCharacteristics[*].courseLevelCharacteristicDescriptor" + ], + "OfferedGradeLevel": [ + "$.offeredGradeLevels[*].gradeLevelDescriptor" + ], + "OfficialAttendancePeriod": [ + "$.officialAttendancePeriod" + ], + "SectionName": [ + "$.sectionName" + ] + } + }, + "sectionAttendanceTakenEvents": { + "resourceName": "SectionAttendanceTakenEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SectionAttendanceTakenEvent", + "description": "Captures attendance taken event for given section.", + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "calendarDateReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the calendar event." + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear", + "date" + ] + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the section attendance taken event was submitted, which could be a different date than the instructional day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "sectionReference", + "calendarDateReference", + "eventDate" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SectionAttendanceTakenEvent", + "description": "Captures attendance taken event for given section.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "calendarDateReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the calendar event." + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear", + "date" + ] + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the section attendance taken event was submitted, which could be a different date than the instructional day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "sectionReference", + "calendarDateReference", + "eventDate" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SectionAttendanceTakenEvent", + "description": "Captures attendance taken event for given section.", + "type": "object", + "properties": { + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "calendarDateReference": { + "type": "object", + "properties": { + "calendarCode": { + "type": "string", + "description": "The identifier for the calendar.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "date": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the calendar event." + } + }, + "additionalProperties": false, + "required": [ + "calendarCode", + "schoolId", + "schoolYear", + "date" + ] + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "The date the section attendance taken event was submitted, which could be a different date than the instructional day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.calendarDateReference.schoolId", + "targetJsonPath": "$.sectionReference.schoolId" + }, + { + "sourceJsonPath": "$.calendarDateReference.schoolYear", + "targetJsonPath": "$.sectionReference.schoolYear" + } + ], + "identityFullnames": [ + "Section", + "CalendarDate" + ], + "documentPathsMapping": { + "Section": [ + "$.sectionReference.localCourseCode", + "$.sectionReference.schoolId", + "$.sectionReference.schoolYear", + "$.sectionReference.sectionIdentifier", + "$.sectionReference.sessionName" + ], + "CalendarDate": [ + "$.calendarDateReference.calendarCode", + "$.calendarDateReference.date", + "$.calendarDateReference.schoolId", + "$.calendarDateReference.schoolYear" + ], + "EventDate": [ + "$.eventDate" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "sessions": { + "resourceName": "Session", + "isDescriptor": false, + "allowIdentityUpdates": true, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Session", + "description": "A term in the school year, generally a unit of time into which courses are scheduled, instruction occurs and by which credits are awarded. Sessions may be interrupted by vacations or other events.", + "type": "object", + "properties": { + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the session." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day and year of the last day of the session." + }, + "termDescriptor": { + "type": "string", + "description": "An descriptor value indicating the term." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total number of instructional days in the school calendar.", + "minimum": 0 + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicWeeks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicWeekReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "weekIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "academicWeekReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "sessionName", + "schoolYearTypeReference", + "beginDate", + "endDate", + "termDescriptor", + "totalInstructionalDays", + "schoolReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Session", + "description": "A term in the school year, generally a unit of time into which courses are scheduled, instruction occurs and by which credits are awarded. Sessions may be interrupted by vacations or other events.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the session." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day and year of the last day of the session." + }, + "termDescriptor": { + "type": "string", + "description": "An descriptor value indicating the term." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total number of instructional days in the school calendar.", + "minimum": 0 + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicWeeks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicWeekReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "weekIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "academicWeekReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "sessionName", + "schoolYearTypeReference", + "beginDate", + "endDate", + "termDescriptor", + "totalInstructionalDays", + "schoolReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Session", + "description": "A term in the school year, generally a unit of time into which courses are scheduled, instruction occurs and by which credits are awarded. Sessions may be interrupted by vacations or other events.", + "type": "object", + "properties": { + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the first day of the session." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "Month, day and year of the last day of the session." + }, + "termDescriptor": { + "type": "string", + "description": "An descriptor value indicating the term." + }, + "totalInstructionalDays": { + "type": "integer", + "description": "The total number of instructional days in the school calendar.", + "minimum": 0 + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "gradingPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "academicWeeks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "academicWeekReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "weekIdentifier": { + "type": "string", + "description": "The school label for the week.", + "minLength": 5, + "maxLength": 80 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "weekIdentifier" + ] + } + }, + "additionalProperties": false, + "required": [ + "academicWeekReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.gradingPeriods[*].gradingPeriodReference.schoolYear", + "targetJsonPath": "$.schoolYearTypeReference.schoolYear" + }, + { + "sourceJsonPath": "$.gradingPeriods[*].gradingPeriodReference.schoolId", + "targetJsonPath": "$.schoolReference.schoolId" + } + ], + "identityFullnames": [ + "SessionName", + "SchoolYear", + "School" + ], + "documentPathsMapping": { + "SessionName": [ + "$.sessionName" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "Term": [ + "$.termDescriptor" + ], + "TotalInstructionalDays": [ + "$.totalInstructionalDays" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "GradingPeriod": [ + "$.gradingPeriods[*].gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriods[*].gradingPeriodReference.periodSequence", + "$.gradingPeriods[*].gradingPeriodReference.schoolId", + "$.gradingPeriods[*].gradingPeriodReference.schoolYear" + ], + "AcademicWeek": [ + "$.academicWeeks[*].academicWeekReference.schoolId", + "$.academicWeeks[*].academicWeekReference.weekIdentifier" + ] + } + }, + "sourceDimensions": { + "resourceName": "SourceDimension", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SourceDimension", + "description": "The NCES source dimension. This dimension is used to segregate costs by school and operational unit such as physical location, department, or other method.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account source dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account source dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account source dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "code", + "fiscalYear" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SourceDimension", + "description": "The NCES source dimension. This dimension is used to segregate costs by school and operational unit such as physical location, department, or other method.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "code": { + "type": "string", + "description": "The code representation of the account source dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account source dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account source dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "code", + "fiscalYear" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SourceDimension", + "description": "The NCES source dimension. This dimension is used to segregate costs by school and operational unit such as physical location, department, or other method.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code representation of the account source dimension.", + "minLength": 1, + "maxLength": 16 + }, + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the account source dimension is valid.", + "minimum": 2020, + "maximum": 2040 + }, + "codeName": { + "type": "string", + "description": "A description of the account source dimension.", + "minLength": 1, + "maxLength": 100 + }, + "reportingTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportingTagDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "reportingTagDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Code", + "FiscalYear" + ], + "documentPathsMapping": { + "Code": [ + "$.code" + ], + "FiscalYear": [ + "$.fiscalYear" + ], + "CodeName": [ + "$.codeName" + ], + "ReportingTag": [ + "$.reportingTags[*].reportingTagDescriptor" + ] + } + }, + "staffs": { + "resourceName": "Staff", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Staff", + "description": "This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion.", + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "staffIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the staff Identification Code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "staffIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "hispanicLatinoEthnicity": { + "type": "boolean", + "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.\"" + }, + "races": { + "type": "array", + "items": { + "type": "object", + "properties": { + "raceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "raceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "yearsOfPriorProfessionalExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a similar professional position in one or more education institutions prior to the current school year." + }, + "yearsOfPriorTeachingExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a teaching position in one or more education institutions prior to the current school year." + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "highlyQualifiedTeacher": { + "type": "boolean", + "description": "An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL Sections being taught." + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the individual for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of recognition earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the recognition expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "credentials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credentialReference": { + "type": "object", + "properties": { + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "credentialReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "tribalAffiliations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tribalAffiliationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "tribalAffiliationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "ancestryEthnicOrigins": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ancestryEthnicOriginDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "ancestryEthnicOriginDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Staff", + "description": "This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "staffIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the staff Identification Code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "staffIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "hispanicLatinoEthnicity": { + "type": "boolean", + "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.\"" + }, + "races": { + "type": "array", + "items": { + "type": "object", + "properties": { + "raceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "raceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "yearsOfPriorProfessionalExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a similar professional position in one or more education institutions prior to the current school year." + }, + "yearsOfPriorTeachingExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a teaching position in one or more education institutions prior to the current school year." + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "highlyQualifiedTeacher": { + "type": "boolean", + "description": "An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL Sections being taught." + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the individual for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of recognition earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the recognition expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "credentials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credentialReference": { + "type": "object", + "properties": { + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "credentialReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "tribalAffiliations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tribalAffiliationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "tribalAffiliationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "ancestryEthnicOrigins": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ancestryEthnicOriginDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "ancestryEthnicOriginDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "staffUniqueId", + "firstName", + "lastSurname" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Staff", + "description": "This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion.", + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + }, + "staffIdentificationSystemDescriptor": { + "type": "string", + "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." + }, + "assigningOrganizationIdentificationCode": { + "type": "string", + "description": "The organization code or name assigning the staff Identification Code.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "staffIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "sexDescriptor": { + "type": "string", + "description": "A person's gender." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "telephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "telephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + }, + "orderOfPriority": { + "type": "integer", + "description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.", + "minimum": 1 + }, + "textMessageCapabilityIndicator": { + "type": "boolean", + "description": "An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the telephone number should not be published." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "telephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "electronicMailAddress": { + "type": "string", + "description": "The electronic mail (e-mail) address listed for an individual or organization.", + "minLength": 7, + "maxLength": 128 + }, + "electronicMailTypeDescriptor": { + "type": "string", + "description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)" + }, + "primaryEmailAddressIndicator": { + "type": "boolean", + "description": "An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization." + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the electronic email address should not be published." + } + }, + "additionalProperties": false, + "required": [ + "electronicMailAddress", + "electronicMailTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "hispanicLatinoEthnicity": { + "type": "boolean", + "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.\"" + }, + "races": { + "type": "array", + "items": { + "type": "object", + "properties": { + "raceDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "raceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageDescriptor": { + "type": "string", + "description": "A specification of which written or spoken communication is being used." + }, + "uses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageUseDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "languageUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "languageDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "highestCompletedLevelOfEducationDescriptor": { + "type": "string", + "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received)." + }, + "yearsOfPriorProfessionalExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a similar professional position in one or more education institutions prior to the current school year." + }, + "yearsOfPriorTeachingExperience": { + "type": "number", + "description": "The total number of years that an individual has previously held a teaching position in one or more education institutions prior to the current school year." + }, + "loginId": { + "type": "string", + "description": "The login ID for the user; used for security access control interface.", + "minLength": 1, + "maxLength": 60 + }, + "highlyQualifiedTeacher": { + "type": "boolean", + "description": "An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL Sections being taught." + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the individual for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of recognition earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the recognition expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "credentials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "credentialReference": { + "type": "object", + "properties": { + "credentialIdentifier": { + "type": "string", + "description": "Identifier or serial number assigned to the credential.", + "minLength": 1, + "maxLength": 60 + }, + "stateOfIssueStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued." + } + }, + "additionalProperties": false, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ] + } + }, + "additionalProperties": false, + "required": [ + "credentialReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "tribalAffiliations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tribalAffiliationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "tribalAffiliationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "ancestryEthnicOrigins": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ancestryEthnicOriginDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "ancestryEthnicOriginDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "StaffUniqueId" + ], + "documentPathsMapping": { + "StaffUniqueId": [ + "$.staffUniqueId" + ], + "Sex": [ + "$.sexDescriptor" + ], + "BirthDate": [ + "$.birthDate" + ], + "HispanicLatinoEthnicity": [ + "$.hispanicLatinoEthnicity" + ], + "Race": [ + "$.races[*].raceDescriptor" + ], + "HighestCompletedLevelOfEducation": [ + "$.highestCompletedLevelOfEducationDescriptor" + ], + "YearsOfPriorProfessionalExperience": [ + "$.yearsOfPriorProfessionalExperience" + ], + "YearsOfPriorTeachingExperience": [ + "$.yearsOfPriorTeachingExperience" + ], + "LoginId": [ + "$.loginId" + ], + "HighlyQualifiedTeacher": [ + "$.highlyQualifiedTeacher" + ], + "Credential": [ + "$.credentials[*].credentialReference.credentialIdentifier", + "$.credentials[*].credentialReference.stateOfIssueStateAbbreviationDescriptor" + ], + "TribalAffiliation": [ + "$.tribalAffiliations[*].tribalAffiliationDescriptor" + ], + "Person": [ + "$.personReference.personId", + "$.personReference.sourceSystemDescriptor" + ], + "AncestryEthnicOrigin": [ + "$.ancestryEthnicOrigins[*].ancestryEthnicOriginDescriptor" + ] + } + }, + "staffAbsenceEvents": { + "resourceName": "StaffAbsenceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffAbsenceEvent", + "description": "This event entity represents the recording of the dates of staff absence.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this leave event." + }, + "absenceEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of absence." + }, + "absenceEventReason": { + "type": "string", + "description": "Expanded reason for the staff absence.", + "minLength": 1, + "maxLength": 40 + }, + "hoursAbsent": { + "type": "number", + "description": "The hours the staff was absent, if not the entire working day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "absenceEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffAbsenceEvent", + "description": "This event entity represents the recording of the dates of staff absence.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this leave event." + }, + "absenceEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of absence." + }, + "absenceEventReason": { + "type": "string", + "description": "Expanded reason for the staff absence.", + "minLength": 1, + "maxLength": 40 + }, + "hoursAbsent": { + "type": "number", + "description": "The hours the staff was absent, if not the entire working day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "absenceEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffAbsenceEvent", + "description": "This event entity represents the recording of the dates of staff absence.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this leave event." + }, + "absenceEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of absence." + }, + "absenceEventReason": { + "type": "string", + "description": "Expanded reason for the staff absence.", + "minLength": 1, + "maxLength": 40 + }, + "hoursAbsent": { + "type": "number", + "description": "The hours the staff was absent, if not the entire working day." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EventDate", + "AbsenceEventCategory", + "Staff" + ], + "documentPathsMapping": { + "EventDate": [ + "$.eventDate" + ], + "AbsenceEventCategory": [ + "$.absenceEventCategoryDescriptor" + ], + "AbsenceEventReason": [ + "$.absenceEventReason" + ], + "HoursAbsent": [ + "$.hoursAbsent" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "staffLeaves": { + "resourceName": "StaffLeave", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffLeave", + "description": "This entity represents the recording of the dates of staff leave (e.g., sick leave, personal time, vacation).", + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The begin date of the staff leave." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the staff leave." + }, + "staffLeaveEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of leave taken." + }, + "reason": { + "type": "string", + "description": "Expanded reason for the staff leave.", + "minLength": 1, + "maxLength": 40 + }, + "substituteAssigned": { + "type": "boolean", + "description": "Indicator of whether a substitute was assigned during the period of staff leave." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffLeave", + "description": "This entity represents the recording of the dates of staff leave (e.g., sick leave, personal time, vacation).", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The begin date of the staff leave." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the staff leave." + }, + "staffLeaveEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of leave taken." + }, + "reason": { + "type": "string", + "description": "Expanded reason for the staff leave.", + "minLength": 1, + "maxLength": 40 + }, + "substituteAssigned": { + "type": "boolean", + "description": "Indicator of whether a substitute was assigned during the period of staff leave." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StaffLeave", + "description": "This entity represents the recording of the dates of staff leave (e.g., sick leave, personal time, vacation).", + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The begin date of the staff leave." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the staff leave." + }, + "staffLeaveEventCategoryDescriptor": { + "type": "string", + "description": "The code describing the type of leave taken." + }, + "reason": { + "type": "string", + "description": "Expanded reason for the staff leave.", + "minLength": 1, + "maxLength": 40 + }, + "substituteAssigned": { + "type": "boolean", + "description": "Indicator of whether a substitute was assigned during the period of staff leave." + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "StaffLeaveEventCategory", + "Staff" + ], + "documentPathsMapping": { + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "StaffLeaveEventCategory": [ + "$.staffLeaveEventCategoryDescriptor" + ], + "Reason": [ + "$.reason" + ], + "SubstituteAssigned": [ + "$.substituteAssigned" + ], + "Staff": [ + "$.staffReference.staffUniqueId" + ] + } + }, + "students": { + "resourceName": "Student", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Student", + "description": "This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.", + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "birthCity": { + "type": "string", + "description": "The city the student was born in.", + "minLength": 2, + "maxLength": 30 + }, + "birthStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born." + }, + "birthInternationalProvince": { + "type": "string", + "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", + "minLength": 1, + "maxLength": 150 + }, + "birthCountryDescriptor": { + "type": "string", + "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "dateEnteredUS": { + "type": "string", + "format": "date", + "description": "For students born outside of the U.S., the date the student entered the U.S." + }, + "multipleBirthStatus": { + "type": "boolean", + "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)" + }, + "birthSexDescriptor": { + "type": "string", + "description": "A person's gender at birth." + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId", + "firstName", + "lastSurname", + "birthDate" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Student", + "description": "This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "birthCity": { + "type": "string", + "description": "The city the student was born in.", + "minLength": 2, + "maxLength": 30 + }, + "birthStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born." + }, + "birthInternationalProvince": { + "type": "string", + "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", + "minLength": 1, + "maxLength": 150 + }, + "birthCountryDescriptor": { + "type": "string", + "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "dateEnteredUS": { + "type": "string", + "format": "date", + "description": "For students born outside of the U.S., the date the student entered the U.S." + }, + "multipleBirthStatus": { + "type": "boolean", + "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)" + }, + "birthSexDescriptor": { + "type": "string", + "description": "A person's gender at birth." + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentUniqueId", + "firstName", + "lastSurname", + "birthDate" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Student", + "description": "This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.", + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + }, + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "maidenName": { + "type": "string", + "description": "The individual's maiden name.", + "minLength": 1, + "maxLength": 75 + }, + "preferredFirstName": { + "type": "string", + "description": "The first name the individual prefers, if different from their legal first name", + "minLength": 1, + "maxLength": 75 + }, + "preferredLastSurname": { + "type": "string", + "description": "The last name the individual prefers, if different from their legal last name", + "minLength": 1, + "maxLength": 75 + }, + "personalIdentificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false, + "required": [ + "personalInformationVerificationDescriptor", + "identificationDocumentUseDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "otherNames": { + "type": "array", + "items": { + "type": "object", + "properties": { + "personalTitlePrefix": { + "type": "string", + "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", + "minLength": 1, + "maxLength": 30 + }, + "firstName": { + "type": "string", + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "minLength": 1, + "maxLength": 75 + }, + "middleName": { + "type": "string", + "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", + "minLength": 1, + "maxLength": 75 + }, + "lastSurname": { + "type": "string", + "description": "The name borne in common by members of a family.", + "minLength": 1, + "maxLength": 75 + }, + "generationCodeSuffix": { + "type": "string", + "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", + "minLength": 1, + "maxLength": 10 + }, + "otherNameTypeDescriptor": { + "type": "string", + "description": "The types of alternate names for an individual." + } + }, + "additionalProperties": false, + "required": [ + "firstName", + "lastSurname", + "otherNameTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which an individual was born." + }, + "birthCity": { + "type": "string", + "description": "The city the student was born in.", + "minLength": 2, + "maxLength": 30 + }, + "birthStateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born." + }, + "birthInternationalProvince": { + "type": "string", + "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", + "minLength": 1, + "maxLength": 150 + }, + "birthCountryDescriptor": { + "type": "string", + "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "dateEnteredUS": { + "type": "string", + "format": "date", + "description": "For students born outside of the U.S., the date the student entered the U.S." + }, + "multipleBirthStatus": { + "type": "boolean", + "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)" + }, + "birthSexDescriptor": { + "type": "string", + "description": "A person's gender at birth." + }, + "citizenshipStatusDescriptor": { + "type": "string", + "description": "An indicator of whether or not the person is a U.S. citizen." + }, + "visas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "visaDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "visaDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationDocuments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "documentTitle": { + "type": "string", + "description": "The title of the document given by the issuer.", + "minLength": 1, + "maxLength": 60 + }, + "personalInformationVerificationDescriptor": { + "type": "string", + "description": "The category of the document relative to its purpose." + }, + "documentExpirationDate": { + "type": "string", + "format": "date", + "description": "The day when the document expires, if null then never expires." + }, + "issuerDocumentIdentificationCode": { + "type": "string", + "description": "The unique identifier on the issuer's identification system.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "Name of the entity or institution that issued the document.", + "minLength": 1, + "maxLength": 150 + }, + "issuerCountryDescriptor": { + "type": "string", + "description": "Country of origin of the document. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "identificationDocumentUseDescriptor": { + "type": "string", + "description": "The primary function of the document used for establishing identity." + } + }, + "additionalProperties": false + }, + "minItems": 0, + "uniqueItems": false + }, + "personReference": { + "type": "object", + "properties": { + "personId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a person.", + "minLength": 1, + "maxLength": 32 + }, + "sourceSystemDescriptor": { + "type": "string", + "description": "This descriptor defines the originating record source system for the person." + } + }, + "additionalProperties": false, + "required": [ + "personId", + "sourceSystemDescriptor" + ] + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "StudentUniqueId" + ], + "documentPathsMapping": { + "StudentUniqueId": [ + "$.studentUniqueId" + ], + "Person": [ + "$.personReference.personId", + "$.personReference.sourceSystemDescriptor" + ] + } + }, + "studentAcademicRecords": { + "resourceName": "StudentAcademicRecord", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAcademicRecord", + "description": "This educational entity represents the cumulative record of academic achievement for a student.", + "type": "object", + "properties": { + "cumulativeEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "classRanking": { + "type": "object", + "properties": { + "classRank": { + "type": "integer", + "description": "The academic rank of a student in relation to his or her graduating class (e.g., 1st, 2nd, 3rd)." + }, + "totalNumberInClass": { + "type": "integer", + "description": "The total number of students in the student's graduating class." + }, + "percentageRanking": { + "type": "integer", + "description": "The academic percentage rank of a student in relation to his or her graduating class (e.g., 95%, 80%, 50%)." + }, + "classRankingDate": { + "type": "string", + "format": "date", + "description": "Date class ranking was determined." + } + }, + "additionalProperties": false, + "required": [ + "classRank", + "totalNumberInClass" + ] + }, + "academicHonors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "academicHonorCategoryDescriptor": { + "type": "string", + "description": "A designation of the type of academic distinctions earned by or awarded to the individual." + }, + "honorDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "honorAwardDate": { + "type": "string", + "format": "date", + "description": "The date the honor was awarded." + }, + "honorAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the honor expires." + } + }, + "additionalProperties": false, + "required": [ + "academicHonorCategoryDescriptor", + "honorDescription" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the individual for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of recognition earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the recognition expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "projectedGraduationDate": { + "type": "string", + "format": "date", + "description": "The month and year the student is projected to graduate." + }, + "sessionEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "diplomas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "diplomaAwardDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student met graduation requirements and was awarded a diploma." + }, + "diplomaLevelDescriptor": { + "type": "string", + "description": "The level of diploma/credential that is awarded to a student in recognition of completion of the curricular requirements." + }, + "diplomaTypeDescriptor": { + "type": "string", + "description": "The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements." + }, + "cteCompleter": { + "type": "boolean", + "description": "Indicated a student who reached a state-defined threshold of vocational education and who attained a high school diploma or its recognized state equivalent or GED." + }, + "diplomaDescription": { + "type": "string", + "description": "The description of the diploma given to the student for accomplishments.", + "minLength": 1, + "maxLength": 80 + }, + "diplomaAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the diploma expires." + } + }, + "additionalProperties": false, + "required": [ + "diplomaAwardDate", + "diplomaTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + }, + "reportCards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportCardReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "reportCardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "educationOrganizationReference", + "schoolYearTypeReference", + "termDescriptor" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAcademicRecord", + "description": "This educational entity represents the cumulative record of academic achievement for a student.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "cumulativeEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "classRanking": { + "type": "object", + "properties": { + "classRank": { + "type": "integer", + "description": "The academic rank of a student in relation to his or her graduating class (e.g., 1st, 2nd, 3rd)." + }, + "totalNumberInClass": { + "type": "integer", + "description": "The total number of students in the student's graduating class." + }, + "percentageRanking": { + "type": "integer", + "description": "The academic percentage rank of a student in relation to his or her graduating class (e.g., 95%, 80%, 50%)." + }, + "classRankingDate": { + "type": "string", + "format": "date", + "description": "Date class ranking was determined." + } + }, + "additionalProperties": false, + "required": [ + "classRank", + "totalNumberInClass" + ] + }, + "academicHonors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "academicHonorCategoryDescriptor": { + "type": "string", + "description": "A designation of the type of academic distinctions earned by or awarded to the individual." + }, + "honorDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "honorAwardDate": { + "type": "string", + "format": "date", + "description": "The date the honor was awarded." + }, + "honorAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the honor expires." + } + }, + "additionalProperties": false, + "required": [ + "academicHonorCategoryDescriptor", + "honorDescription" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the individual for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of recognition earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the recognition expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "projectedGraduationDate": { + "type": "string", + "format": "date", + "description": "The month and year the student is projected to graduate." + }, + "sessionEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "diplomas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "diplomaAwardDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student met graduation requirements and was awarded a diploma." + }, + "diplomaLevelDescriptor": { + "type": "string", + "description": "The level of diploma/credential that is awarded to a student in recognition of completion of the curricular requirements." + }, + "diplomaTypeDescriptor": { + "type": "string", + "description": "The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements." + }, + "cteCompleter": { + "type": "boolean", + "description": "Indicated a student who reached a state-defined threshold of vocational education and who attained a high school diploma or its recognized state equivalent or GED." + }, + "diplomaDescription": { + "type": "string", + "description": "The description of the diploma given to the student for accomplishments.", + "minLength": 1, + "maxLength": 80 + }, + "diplomaAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the diploma expires." + } + }, + "additionalProperties": false, + "required": [ + "diplomaAwardDate", + "diplomaTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + }, + "reportCards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportCardReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "reportCardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "educationOrganizationReference", + "schoolYearTypeReference", + "termDescriptor" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAcademicRecord", + "description": "This educational entity represents the cumulative record of academic achievement for a student.", + "type": "object", + "properties": { + "cumulativeEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "cumulativeAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "cumulativeAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "classRanking": { + "type": "object", + "properties": { + "classRank": { + "type": "integer", + "description": "The academic rank of a student in relation to his or her graduating class (e.g., 1st, 2nd, 3rd)." + }, + "totalNumberInClass": { + "type": "integer", + "description": "The total number of students in the student's graduating class." + }, + "percentageRanking": { + "type": "integer", + "description": "The academic percentage rank of a student in relation to his or her graduating class (e.g., 95%, 80%, 50%)." + }, + "classRankingDate": { + "type": "string", + "format": "date", + "description": "Date class ranking was determined." + } + }, + "additionalProperties": false, + "required": [ + "classRank", + "totalNumberInClass" + ] + }, + "academicHonors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "academicHonorCategoryDescriptor": { + "type": "string", + "description": "A designation of the type of academic distinctions earned by or awarded to the individual." + }, + "honorDescription": { + "type": "string", + "description": "A description of the type of academic distinctions earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "honorAwardDate": { + "type": "string", + "format": "date", + "description": "The date the honor was awarded." + }, + "honorAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the honor expires." + } + }, + "additionalProperties": false, + "required": [ + "academicHonorCategoryDescriptor", + "honorDescription" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "recognitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "recognitionTypeDescriptor": { + "type": "string", + "description": "The nature of recognition given to the individual for accomplishments in a co-curricular, or extra-curricular activity." + }, + "recognitionDescription": { + "type": "string", + "description": "A description of the type of recognition earned by or awarded to the individual.", + "minLength": 1, + "maxLength": 80 + }, + "recognitionAwardDate": { + "type": "string", + "format": "date", + "description": "The date the recognition was awarded or earned." + }, + "recognitionAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the recognition expires." + } + }, + "additionalProperties": false, + "required": [ + "recognitionTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "projectedGraduationDate": { + "type": "string", + "format": "date", + "description": "The month and year the student is projected to graduate." + }, + "sessionEarnedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionEarnedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "sessionAttemptedCredits": { + "type": "number", + "description": "The value of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditTypeDescriptor": { + "type": "string", + "description": "The type of credits or units of value awarded for the completion of a course." + }, + "sessionAttemptedCreditConversions": { + "type": "number", + "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units." + }, + "gradePointAverages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradePointAverageTypeDescriptor": { + "type": "string", + "description": "The system used for calculating the grade point average for an individual." + }, + "isCumulative": { + "type": "boolean", + "description": "Indicator of whether or not the Grade Point Average value is cumulative." + }, + "gradePointAverageValue": { + "type": "number", + "description": "The value of the grade points earned divided by the number of credits attempted." + }, + "maxGradePointAverageValue": { + "type": "number", + "description": "The maximum value for the grade point average." + } + }, + "additionalProperties": false, + "required": [ + "gradePointAverageTypeDescriptor", + "gradePointAverageValue" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "diplomas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "achievementTitle": { + "type": "string", + "description": "The title assigned to the achievement.", + "minLength": 1, + "maxLength": 60 + }, + "achievementCategoryDescriptor": { + "type": "string", + "description": "The category of achievement attributed to the individual." + }, + "achievementCategorySystem": { + "type": "string", + "description": "The system that defines the categories by which an achievement is attributed to the individual.", + "minLength": 1, + "maxLength": 60 + }, + "issuerName": { + "type": "string", + "description": "The name of the agent, entity, or institution issuing the element.", + "minLength": 1, + "maxLength": 150 + }, + "issuerOriginURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) from which the award was issued.", + "minLength": 5, + "maxLength": 255 + }, + "criteria": { + "type": "string", + "description": "The criteria for competency-based completion of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "criteriaURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of a web page describing the competency-based completion criteria for the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "evidenceStatement": { + "type": "string", + "description": "A statement or reference describing the evidence that the individual met the criteria for attainment of the achievement/award.", + "minLength": 1, + "maxLength": 150 + }, + "imageURL": { + "type": "string", + "description": "The Uniform Resource Locator (URL) for the unique address of an image representing an award or badge associated with the achievement/award.", + "minLength": 5, + "maxLength": 255 + }, + "diplomaAwardDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student met graduation requirements and was awarded a diploma." + }, + "diplomaLevelDescriptor": { + "type": "string", + "description": "The level of diploma/credential that is awarded to a student in recognition of completion of the curricular requirements." + }, + "diplomaTypeDescriptor": { + "type": "string", + "description": "The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements." + }, + "cteCompleter": { + "type": "boolean", + "description": "Indicated a student who reached a state-defined threshold of vocational education and who attained a high school diploma or its recognized state equivalent or GED." + }, + "diplomaDescription": { + "type": "string", + "description": "The description of the diploma given to the student for accomplishments.", + "minLength": 1, + "maxLength": 80 + }, + "diplomaAwardExpiresDate": { + "type": "string", + "format": "date", + "description": "Date on which the diploma expires." + } + }, + "additionalProperties": false, + "required": [ + "diplomaAwardDate", + "diplomaTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "termDescriptor": { + "type": "string", + "description": "The term for the session during the school year." + }, + "reportCards": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportCardReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear", + "studentUniqueId" + ] + } + }, + "additionalProperties": false, + "required": [ + "reportCardReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.reportCards[*].reportCardReference.educationOrganizationId", + "targetJsonPath": "$.educationOrganizationReference.educationOrganizationId" + }, + { + "sourceJsonPath": "$.reportCards[*].reportCardReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "Student", + "EducationOrganization", + "SchoolYear", + "Term" + ], + "documentPathsMapping": { + "ProjectedGraduationDate": [ + "$.projectedGraduationDate" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "Term": [ + "$.termDescriptor" + ], + "ReportCard": [ + "$.reportCards[*].reportCardReference.educationOrganizationId", + "$.reportCards[*].reportCardReference.gradingPeriodDescriptor", + "$.reportCards[*].reportCardReference.periodSequence", + "$.reportCards[*].reportCardReference.schoolId", + "$.reportCards[*].reportCardReference.schoolYear", + "$.reportCards[*].reportCardReference.studentUniqueId" + ] + } + }, + "studentAssessments": { + "resourceName": "StudentAssessment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAssessment", + "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.", + "type": "object", + "properties": { + "studentAssessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment administered to a student.", + "minLength": 1, + "maxLength": 60 + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + }, + "serialNumber": { + "type": "string", + "description": "The unique number for the assessment form or answer document.", + "minLength": 1, + "maxLength": 60 + }, + "administrationLanguageDescriptor": { + "type": "string", + "description": "The language in which an assessment is written and/or administered." + }, + "administrationEnvironmentDescriptor": { + "type": "string", + "description": "The environment in which the test was administered." + }, + "accommodations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accommodationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "accommodationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "retestIndicatorDescriptor": { + "type": "string", + "description": "Indicator if the test was a retake." + }, + "reasonNotTestedDescriptor": { + "type": "string", + "description": "The primary reason student is not tested." + }, + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenAssessedGradeLevelDescriptor": { + "type": "string", + "description": "The grade level of a student when assessed." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "eventCircumstanceDescriptor": { + "type": "string", + "description": "An unusual event occurred during the administration of the assessment. This could include fire alarm, student became ill, etc." + }, + "eventDescription": { + "type": "string", + "description": "Describes special events that occur before during or after the assessment session that may impact use of results.", + "minLength": 1, + "maxLength": 1024 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentResponse": { + "type": "string", + "description": "A student's response to a stimulus on a test.", + "minLength": 1, + "maxLength": 255 + }, + "descriptiveFeedback": { + "type": "string", + "description": "The formative descriptive feedback that was given to a student in response to the results from a scored/evaluated assessment item.", + "minLength": 1, + "maxLength": 1024 + }, + "responseIndicatorDescriptor": { + "type": "string", + "description": "Indicator of the response." + }, + "assessmentItemResultDescriptor": { + "type": "string", + "description": "The analyzed result of a student's response to an assessment item." + }, + "rawScoreResult": { + "type": "number", + "description": "A meaningful raw score of the performance of a student on an assessment item." + }, + "timeAssessed": { + "type": "number", + "description": "The overall time a student actually spent during the assessment item." + }, + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "itemNumber": { + "type": "integer", + "description": "The test question number for this student's test item." + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemResultDescriptor", + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentObjectiveAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessedMinutes": { + "type": "integer", + "description": "Reported time student was assessed in minutes." + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + } + }, + "additionalProperties": false, + "required": [ + "objectiveAssessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "platformTypeDescriptor": { + "type": "string", + "description": "The platform with which the assessment was delivered to the student during the assessment session." + }, + "period": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "assessedMinutes": { + "type": "integer", + "description": "Reported time student was assessed in minutes." + }, + "reportedSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "reportedSchoolIdentifier": { + "type": "string", + "description": "A reported school identifier for the school the enrollment at the time of the assessment used when the assigned SchoolId is not known by the assessment vendor.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentAssessmentIdentifier", + "studentReference", + "assessmentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAssessment", + "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.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "studentAssessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment administered to a student.", + "minLength": 1, + "maxLength": 60 + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + }, + "serialNumber": { + "type": "string", + "description": "The unique number for the assessment form or answer document.", + "minLength": 1, + "maxLength": 60 + }, + "administrationLanguageDescriptor": { + "type": "string", + "description": "The language in which an assessment is written and/or administered." + }, + "administrationEnvironmentDescriptor": { + "type": "string", + "description": "The environment in which the test was administered." + }, + "accommodations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accommodationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "accommodationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "retestIndicatorDescriptor": { + "type": "string", + "description": "Indicator if the test was a retake." + }, + "reasonNotTestedDescriptor": { + "type": "string", + "description": "The primary reason student is not tested." + }, + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenAssessedGradeLevelDescriptor": { + "type": "string", + "description": "The grade level of a student when assessed." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "eventCircumstanceDescriptor": { + "type": "string", + "description": "An unusual event occurred during the administration of the assessment. This could include fire alarm, student became ill, etc." + }, + "eventDescription": { + "type": "string", + "description": "Describes special events that occur before during or after the assessment session that may impact use of results.", + "minLength": 1, + "maxLength": 1024 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentResponse": { + "type": "string", + "description": "A student's response to a stimulus on a test.", + "minLength": 1, + "maxLength": 255 + }, + "descriptiveFeedback": { + "type": "string", + "description": "The formative descriptive feedback that was given to a student in response to the results from a scored/evaluated assessment item.", + "minLength": 1, + "maxLength": 1024 + }, + "responseIndicatorDescriptor": { + "type": "string", + "description": "Indicator of the response." + }, + "assessmentItemResultDescriptor": { + "type": "string", + "description": "The analyzed result of a student's response to an assessment item." + }, + "rawScoreResult": { + "type": "number", + "description": "A meaningful raw score of the performance of a student on an assessment item." + }, + "timeAssessed": { + "type": "number", + "description": "The overall time a student actually spent during the assessment item." + }, + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "itemNumber": { + "type": "integer", + "description": "The test question number for this student's test item." + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemResultDescriptor", + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentObjectiveAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessedMinutes": { + "type": "integer", + "description": "Reported time student was assessed in minutes." + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + } + }, + "additionalProperties": false, + "required": [ + "objectiveAssessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "platformTypeDescriptor": { + "type": "string", + "description": "The platform with which the assessment was delivered to the student during the assessment session." + }, + "period": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "assessedMinutes": { + "type": "integer", + "description": "Reported time student was assessed in minutes." + }, + "reportedSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "reportedSchoolIdentifier": { + "type": "string", + "description": "A reported school identifier for the school the enrollment at the time of the assessment used when the assigned SchoolId is not known by the assessment vendor.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentAssessmentIdentifier", + "studentReference", + "assessmentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentAssessment", + "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.", + "type": "object", + "properties": { + "studentAssessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment administered to a student.", + "minLength": 1, + "maxLength": 60 + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + }, + "serialNumber": { + "type": "string", + "description": "The unique number for the assessment form or answer document.", + "minLength": 1, + "maxLength": 60 + }, + "administrationLanguageDescriptor": { + "type": "string", + "description": "The language in which an assessment is written and/or administered." + }, + "administrationEnvironmentDescriptor": { + "type": "string", + "description": "The environment in which the test was administered." + }, + "accommodations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accommodationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "accommodationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "retestIndicatorDescriptor": { + "type": "string", + "description": "Indicator if the test was a retake." + }, + "reasonNotTestedDescriptor": { + "type": "string", + "description": "The primary reason student is not tested." + }, + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "whenAssessedGradeLevelDescriptor": { + "type": "string", + "description": "The grade level of a student when assessed." + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "eventCircumstanceDescriptor": { + "type": "string", + "description": "An unusual event occurred during the administration of the assessment. This could include fire alarm, student became ill, etc." + }, + "eventDescription": { + "type": "string", + "description": "Describes special events that occur before during or after the assessment session that may impact use of results.", + "minLength": 1, + "maxLength": 1024 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "assessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace" + ] + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assessmentResponse": { + "type": "string", + "description": "A student's response to a stimulus on a test.", + "minLength": 1, + "maxLength": 255 + }, + "descriptiveFeedback": { + "type": "string", + "description": "The formative descriptive feedback that was given to a student in response to the results from a scored/evaluated assessment item.", + "minLength": 1, + "maxLength": 1024 + }, + "responseIndicatorDescriptor": { + "type": "string", + "description": "Indicator of the response." + }, + "assessmentItemResultDescriptor": { + "type": "string", + "description": "The analyzed result of a student's response to an assessment item." + }, + "rawScoreResult": { + "type": "number", + "description": "A meaningful raw score of the performance of a student on an assessment item." + }, + "timeAssessed": { + "type": "number", + "description": "The overall time a student actually spent during the assessment item." + }, + "assessmentItemReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "itemNumber": { + "type": "integer", + "description": "The test question number for this student's test item." + } + }, + "additionalProperties": false, + "required": [ + "assessmentItemResultDescriptor", + "assessmentItemReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentObjectiveAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scoreResults": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "string", + "description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.", + "minLength": 1, + "maxLength": 35 + }, + "resultDatatypeTypeDescriptor": { + "type": "string", + "description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + } + }, + "additionalProperties": false, + "required": [ + "result", + "resultDatatypeTypeDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "performanceLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "performanceLevelDescriptor": { + "type": "string", + "description": "A specification of which performance level value describes the student proficiency." + }, + "assessmentReportingMethodDescriptor": { + "type": "string", + "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." + }, + "performanceLevelIndicatorName": { + "type": "string", + "description": "The name of the indicator being measured for a collection of performance level values.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "performanceLevelDescriptor", + "assessmentReportingMethodDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "objectiveAssessmentReference": { + "type": "object", + "properties": { + "assessmentIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an assessment.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the assessment.", + "minLength": 5, + "maxLength": 255 + }, + "identificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "assessmentIdentifier", + "namespace", + "identificationCode" + ] + }, + "assessedMinutes": { + "type": "integer", + "description": "Reported time student was assessed in minutes." + }, + "administrationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones." + }, + "administrationEndDate": { + "type": "string", + "format": "date-time", + "description": "The date and time an assessment administration ended." + } + }, + "additionalProperties": false, + "required": [ + "objectiveAssessmentReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "platformTypeDescriptor": { + "type": "string", + "description": "The platform with which the assessment was delivered to the student during the assessment session." + }, + "period": { + "type": "object", + "properties": { + "assessmentPeriodDescriptor": { + "type": "string", + "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)." + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the assessment is to be administered." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the assessment is to be administered." + } + }, + "additionalProperties": false, + "required": [ + "assessmentPeriodDescriptor" + ] + }, + "assessedMinutes": { + "type": "integer", + "description": "Reported time student was assessed in minutes." + }, + "reportedSchoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "reportedSchoolIdentifier": { + "type": "string", + "description": "A reported school identifier for the school the enrollment at the time of the assessment used when the assigned SchoolId is not known by the assessment vendor.", + "minLength": 1, + "maxLength": 60 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.items[*].assessmentItemReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.items[*].assessmentItemReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + }, + { + "sourceJsonPath": "$.studentObjectiveAssessments[*].objectiveAssessmentReference.assessmentIdentifier", + "targetJsonPath": "$.assessmentReference.assessmentIdentifier" + }, + { + "sourceJsonPath": "$.studentObjectiveAssessments[*].objectiveAssessmentReference.namespace", + "targetJsonPath": "$.assessmentReference.namespace" + } + ], + "identityFullnames": [ + "StudentAssessmentIdentifier", + "Student", + "Assessment" + ], + "documentPathsMapping": { + "StudentAssessmentIdentifier": [ + "$.studentAssessmentIdentifier" + ], + "AdministrationDate": [ + "$.administrationDate" + ], + "AdministrationEndDate": [ + "$.administrationEndDate" + ], + "SerialNumber": [ + "$.serialNumber" + ], + "AdministrationLanguage": [ + "$.administrationLanguageDescriptor" + ], + "AdministrationEnvironment": [ + "$.administrationEnvironmentDescriptor" + ], + "Accommodation": [ + "$.accommodations[*].accommodationDescriptor" + ], + "RetestIndicator": [ + "$.retestIndicatorDescriptor" + ], + "ReasonNotTested": [ + "$.reasonNotTestedDescriptor" + ], + "WhenAssessedGradeLevel": [ + "$.whenAssessedGradeLevelDescriptor" + ], + "EventCircumstance": [ + "$.eventCircumstanceDescriptor" + ], + "EventDescription": [ + "$.eventDescription" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Assessment": [ + "$.assessmentReference.assessmentIdentifier", + "$.assessmentReference.namespace" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "PlatformType": [ + "$.platformTypeDescriptor" + ], + "AssessedMinutes": [ + "$.assessedMinutes" + ], + "ReportedSchool": [ + "$.reportedSchoolReference.schoolId" + ], + "ReportedSchoolIdentifier": [ + "$.reportedSchoolIdentifier" + ] + } + }, + "studentCompetencyObjectives": { + "resourceName": "StudentCompetencyObjective", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCompetencyObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific competency objective.", + "type": "object", + "properties": { + "competencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced competency objective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "competencyObjectiveReference", + "competencyLevelDescriptor", + "gradingPeriodReference", + "studentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCompetencyObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific competency objective.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "competencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced competency objective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "competencyObjectiveReference", + "competencyLevelDescriptor", + "gradingPeriodReference", + "studentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCompetencyObjective", + "description": "This entity represents the competency assessed or evaluated for the student against a specific competency objective.", + "type": "object", + "properties": { + "competencyObjectiveReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "objective": { + "type": "string", + "description": "The designated title of the competency objective.", + "minLength": 1, + "maxLength": 60 + }, + "objectiveGradeLevelDescriptor": { + "type": "string", + "description": "The grade level for which the competency objective is targeted." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced competency objective." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "gradingPeriodReference": { + "type": "object", + "properties": { + "gradingPeriodDescriptor": { + "type": "string", + "description": "The name of the period for which grades are reported." + }, + "periodSequence": { + "type": "integer", + "description": "The sequential order of this period relative to other periods." + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false, + "required": [ + "gradingPeriodDescriptor", + "periodSequence", + "schoolId", + "schoolYear" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "studentSectionAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "studentSectionAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "Month, day, and year of the student's entry or assignment to the section." + }, + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "studentSectionAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "generalStudentProgramAssociations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "generalStudentProgramAssociationReference": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + }, + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "generalStudentProgramAssociationReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.studentSectionAssociations[*].studentSectionAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + }, + { + "sourceJsonPath": "$.generalStudentProgramAssociations[*].generalStudentProgramAssociationReference.studentUniqueId", + "targetJsonPath": "$.studentReference.studentUniqueId" + } + ], + "identityFullnames": [ + "CompetencyObjective", + "GradingPeriod", + "Student" + ], + "documentPathsMapping": { + "CompetencyObjective": [ + "$.competencyObjectiveReference.educationOrganizationId", + "$.competencyObjectiveReference.objective", + "$.competencyObjectiveReference.objectiveGradeLevelDescriptor" + ], + "CompetencyLevel": [ + "$.competencyLevelDescriptor" + ], + "DiagnosticStatement": [ + "$.diagnosticStatement" + ], + "GradingPeriod": [ + "$.gradingPeriodReference.gradingPeriodDescriptor", + "$.gradingPeriodReference.periodSequence", + "$.gradingPeriodReference.schoolId", + "$.gradingPeriodReference.schoolYear" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ] + } + }, + "studentGradebookEntries": { + "resourceName": "StudentGradebookEntry", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentGradebookEntry", + "description": "This entity holds a student's grade or competency level for a gradebook entry.", + "type": "object", + "properties": { + "gradebookEntryReference": { + "type": "object", + "properties": { + "gradebookEntryIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace URI for the source of the gradebook entry.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced learning objective." + }, + "dateFulfilled": { + "type": "string", + "format": "date", + "description": "The date an assignment was turned in or the date of an assessment." + }, + "timeFulfilled": { + "type": "string", + "format": "time", + "description": "The time an assignment was turned in on the date fulfilled." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "pointsEarned": { + "type": "number", + "description": "The points earned for the submission. With extra credit, the points earned may exceed the max points." + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "submissionStatusDescriptor": { + "type": "string", + "description": "The status of the student's submission." + }, + "assignmentLateStatusDescriptor": { + "type": "string", + "description": "Status of whether the assignment was submitted after the due date and/or marked as." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "gradebookEntryReference", + "studentReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentGradebookEntry", + "description": "This entity holds a student's grade or competency level for a gradebook entry.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "gradebookEntryReference": { + "type": "object", + "properties": { + "gradebookEntryIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace URI for the source of the gradebook entry.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced learning objective." + }, + "dateFulfilled": { + "type": "string", + "format": "date", + "description": "The date an assignment was turned in or the date of an assessment." + }, + "timeFulfilled": { + "type": "string", + "format": "time", + "description": "The time an assignment was turned in on the date fulfilled." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "pointsEarned": { + "type": "number", + "description": "The points earned for the submission. With extra credit, the points earned may exceed the max points." + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "submissionStatusDescriptor": { + "type": "string", + "description": "The status of the student's submission." + }, + "assignmentLateStatusDescriptor": { + "type": "string", + "description": "Status of whether the assignment was submitted after the due date and/or marked as." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "gradebookEntryReference", + "studentReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentGradebookEntry", + "description": "This entity holds a student's grade or competency level for a gradebook entry.", + "type": "object", + "properties": { + "gradebookEntryReference": { + "type": "object", + "properties": { + "gradebookEntryIdentifier": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace URI for the source of the gradebook entry.", + "minLength": 5, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ] + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "competencyLevelDescriptor": { + "type": "string", + "description": "The competency level assessed for the student for the referenced learning objective." + }, + "dateFulfilled": { + "type": "string", + "format": "date", + "description": "The date an assignment was turned in or the date of an assessment." + }, + "timeFulfilled": { + "type": "string", + "format": "time", + "description": "The time an assignment was turned in on the date fulfilled." + }, + "diagnosticStatement": { + "type": "string", + "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", + "minLength": 1, + "maxLength": 1024 + }, + "pointsEarned": { + "type": "number", + "description": "The points earned for the submission. With extra credit, the points earned may exceed the max points." + }, + "letterGradeEarned": { + "type": "string", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", + "minLength": 1, + "maxLength": 20 + }, + "numericGradeEarned": { + "type": "number", + "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor." + }, + "submissionStatusDescriptor": { + "type": "string", + "description": "The status of the student's submission." + }, + "assignmentLateStatusDescriptor": { + "type": "string", + "description": "Status of whether the assignment was submitted after the due date and/or marked as." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "GradebookEntry", + "Student" + ], + "documentPathsMapping": { + "GradebookEntry": [ + "$.gradebookEntryReference.gradebookEntryIdentifier", + "$.gradebookEntryReference.namespace" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "CompetencyLevel": [ + "$.competencyLevelDescriptor" + ], + "DateFulfilled": [ + "$.dateFulfilled" + ], + "TimeFulfilled": [ + "$.timeFulfilled" + ], + "DiagnosticStatement": [ + "$.diagnosticStatement" + ], + "PointsEarned": [ + "$.pointsEarned" + ], + "LetterGradeEarned": [ + "$.letterGradeEarned" + ], + "NumericGradeEarned": [ + "$.numericGradeEarned" + ], + "SubmissionStatus": [ + "$.submissionStatusDescriptor" + ], + "AssignmentLateStatus": [ + "$.assignmentLateStatusDescriptor" + ] + } + }, + "studentInterventionAttendanceEvents": { + "resourceName": "StudentInterventionAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentInterventionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for an intervention service.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "interventionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ] + }, + "interventionDuration": { + "type": "integer", + "description": "The duration in minutes in which the student participated in the intervention during this instance.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "interventionReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentInterventionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for an intervention service.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "interventionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ] + }, + "interventionDuration": { + "type": "integer", + "description": "The duration in minutes in which the student participated in the intervention during this instance.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "interventionReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentInterventionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for an intervention service.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "interventionReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "interventionIdentificationCode": { + "type": "string", + "description": "A unique number or alphanumeric code assigned to an intervention.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ] + }, + "interventionDuration": { + "type": "integer", + "description": "The duration in minutes in which the student participated in the intervention during this instance.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Student", + "Intervention" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Intervention": [ + "$.interventionReference.educationOrganizationId", + "$.interventionReference.interventionIdentificationCode" + ], + "InterventionDuration": [ + "$.interventionDuration" + ] + } + }, + "studentProgramAttendanceEvents": { + "resourceName": "StudentProgramAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance to receive or participate in program services.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "programAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the program attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "educationOrganizationReference", + "programReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance to receive or participate in program services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "programAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the program attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "educationOrganizationReference", + "programReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance to receive or participate in program services.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "programAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the program attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Student", + "EducationOrganization", + "Program" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "ProgramAttendanceDuration": [ + "$.programAttendanceDuration" + ] + } + }, + "studentSchoolAttendanceEvents": { + "resourceName": "StudentSchoolAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a school day.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "schoolAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the school attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "schoolReference", + "sessionReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a school day.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "schoolAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the school attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "schoolReference", + "sessionReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a school day.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "schoolReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "schoolId" + ] + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "schoolAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the school attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.sessionReference.schoolId", + "targetJsonPath": "$.schoolReference.schoolId" + } + ], + "identityFullnames": [ + "Student", + "School", + "Session" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "School": [ + "$.schoolReference.schoolId" + ], + "Session": [ + "$.sessionReference.schoolId", + "$.sessionReference.schoolYear", + "$.sessionReference.sessionName" + ], + "SchoolAttendanceDuration": [ + "$.schoolAttendanceDuration" + ], + "ArrivalTime": [ + "$.arrivalTime" + ], + "DepartureTime": [ + "$.departureTime" + ] + } + }, + "studentSectionAttendanceEvents": { + "resourceName": "StudentSectionAttendanceEvent", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSectionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a section.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "sectionAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the section attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "sectionReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSectionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a section.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "sectionAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the section attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "eventDate", + "attendanceEventCategoryDescriptor", + "studentReference", + "sectionReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSectionAttendanceEvent", + "description": "This event entity represents the recording of whether a student is in attendance for a section.", + "type": "object", + "properties": { + "eventDate": { + "type": "string", + "format": "date", + "description": "Date for this attendance event." + }, + "attendanceEventCategoryDescriptor": { + "type": "string", + "description": "A code describing the attendance event, for example: Present Unexcused absence Excused absence Tardy." + }, + "attendanceEventReason": { + "type": "string", + "description": "The reported reason for a student's absence.", + "minLength": 1, + "maxLength": 255 + }, + "educationalEnvironmentDescriptor": { + "type": "string", + "description": "The setting in which a child receives education and related services. This attribute is only used if it differs from the EducationalEnvironment of the Section. This is only used in the AttendanceEvent if different from the associated Section." + }, + "eventDuration": { + "type": "number", + "description": "The amount of time for the event as recognized by the school: 1 day = 1, 1/2 day = 0.5, 1/3 day = 0.33." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "sectionReference": { + "type": "object", + "properties": { + "localCourseCode": { + "type": "string", + "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + }, + "sectionIdentifier": { + "type": "string", + "description": "The local identifier assigned to a section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + "sectionIdentifier" + ] + }, + "sectionAttendanceDuration": { + "type": "integer", + "description": "The duration in minutes of the section attendance event.", + "minimum": 0, + "maximum": 1440 + }, + "arrivalTime": { + "type": "string", + "format": "time", + "description": "The time of day the student arrived for the attendance event in ISO 8601 format." + }, + "departureTime": { + "type": "string", + "format": "time", + "description": "The time of day the student departed for the attendance event in ISO 8601 format." + }, + "classPeriods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "classPeriodReference": { + "type": "object", + "properties": { + "classPeriodName": { + "type": "string", + "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", + "minLength": 1, + "maxLength": 60 + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + } + }, + "additionalProperties": false, + "required": [ + "classPeriodName", + "schoolId" + ] + } + }, + "additionalProperties": false, + "required": [ + "classPeriodReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.classPeriods[*].classPeriodReference.schoolId", + "targetJsonPath": "$.sectionReference.schoolId" + } + ], + "identityFullnames": [ + "Student", + "Section" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Section": [ + "$.sectionReference.localCourseCode", + "$.sectionReference.schoolId", + "$.sectionReference.schoolYear", + "$.sectionReference.sectionIdentifier", + "$.sectionReference.sessionName" + ], + "SectionAttendanceDuration": [ + "$.sectionAttendanceDuration" + ], + "ArrivalTime": [ + "$.arrivalTime" + ], + "DepartureTime": [ + "$.departureTime" + ], + "ClassPeriod": [ + "$.classPeriods[*].classPeriodReference.classPeriodName", + "$.classPeriods[*].classPeriodReference.schoolId" + ] + } + }, + "surveys": { + "resourceName": "Survey", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Survey", + "description": "A survey to identified or anonymous respondents.", + "type": "object", + "properties": { + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "surveyTitle": { + "type": "string", + "description": "The title of the survey.", + "minLength": 1, + "maxLength": 255 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "surveyCategoryDescriptor": { + "type": "string", + "description": "The category or type of survey." + }, + "numberAdministered": { + "type": "integer", + "description": "Number of persons to whom this survey was administered." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyIdentifier", + "namespace", + "surveyTitle", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Survey", + "description": "A survey to identified or anonymous respondents.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "surveyTitle": { + "type": "string", + "description": "The title of the survey.", + "minLength": 1, + "maxLength": 255 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "surveyCategoryDescriptor": { + "type": "string", + "description": "The category or type of survey." + }, + "numberAdministered": { + "type": "integer", + "description": "Number of persons to whom this survey was administered." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyIdentifier", + "namespace", + "surveyTitle", + "schoolYearTypeReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.Survey", + "description": "A survey to identified or anonymous respondents.", + "type": "object", + "properties": { + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "surveyTitle": { + "type": "string", + "description": "The title of the survey.", + "minLength": 1, + "maxLength": 255 + }, + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "sessionReference": { + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + }, + "sessionName": { + "type": "string", + "description": "The identifier for the calendar for the academic session.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ] + }, + "surveyCategoryDescriptor": { + "type": "string", + "description": "The category or type of survey." + }, + "numberAdministered": { + "type": "integer", + "description": "Number of persons to whom this survey was administered." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "SurveyIdentifier", + "Namespace" + ], + "documentPathsMapping": { + "SurveyIdentifier": [ + "$.surveyIdentifier" + ], + "Namespace": [ + "$.namespace" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "SurveyTitle": [ + "$.surveyTitle" + ], + "SchoolYear": [ + "$.schoolYearTypeReference.schoolYear" + ], + "Session": [ + "$.sessionReference.schoolId", + "$.sessionReference.schoolYear", + "$.sessionReference.sessionName" + ], + "SurveyCategory": [ + "$.surveyCategoryDescriptor" + ], + "NumberAdministered": [ + "$.numberAdministered" + ] + } + }, + "surveyQuestions": { + "resourceName": "SurveyQuestion", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestion", + "description": "The questions for the survey.", + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "questionFormDescriptor": { + "type": "string", + "description": "The form or type of question." + }, + "questionText": { + "type": "string", + "description": "The text of the question.", + "minLength": 1, + "maxLength": 1024 + }, + "responseChoices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sortOrder": { + "type": "integer", + "description": "Sort order of this ResponseChoice within the complete list of choices attached to a SurveyQuestion. If sort order doesn't apply, the value of NumericValue or a unique, possibly sequential numeric value." + }, + "numericValue": { + "type": "integer", + "description": "A valid numeric response. If paired with a TextValue, the numeric equivalent of the TextValue.", + "minimum": 0, + "maximum": 100 + }, + "textValue": { + "type": "string", + "description": "A valid text response. If paired with a NumericValue, the text equivalent of the NumericValue.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "sortOrder" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "matrices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "minRawScore": { + "type": "integer", + "description": "The minimum score possible on a survey." + }, + "maxRawScore": { + "type": "integer", + "description": "The maximum score possible on a survey." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "surveyReference", + "questionFormDescriptor", + "questionText" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestion", + "description": "The questions for the survey.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "questionFormDescriptor": { + "type": "string", + "description": "The form or type of question." + }, + "questionText": { + "type": "string", + "description": "The text of the question.", + "minLength": 1, + "maxLength": 1024 + }, + "responseChoices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sortOrder": { + "type": "integer", + "description": "Sort order of this ResponseChoice within the complete list of choices attached to a SurveyQuestion. If sort order doesn't apply, the value of NumericValue or a unique, possibly sequential numeric value." + }, + "numericValue": { + "type": "integer", + "description": "A valid numeric response. If paired with a TextValue, the numeric equivalent of the TextValue.", + "minimum": 0, + "maximum": 100 + }, + "textValue": { + "type": "string", + "description": "A valid text response. If paired with a NumericValue, the text equivalent of the NumericValue.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "sortOrder" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "matrices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "minRawScore": { + "type": "integer", + "description": "The minimum score possible on a survey." + }, + "maxRawScore": { + "type": "integer", + "description": "The maximum score possible on a survey." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "questionCode", + "surveyReference", + "questionFormDescriptor", + "questionText" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestion", + "description": "The questions for the survey.", + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "questionFormDescriptor": { + "type": "string", + "description": "The form or type of question." + }, + "questionText": { + "type": "string", + "description": "The text of the question.", + "minLength": 1, + "maxLength": 1024 + }, + "responseChoices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sortOrder": { + "type": "integer", + "description": "Sort order of this ResponseChoice within the complete list of choices attached to a SurveyQuestion. If sort order doesn't apply, the value of NumericValue or a unique, possibly sequential numeric value." + }, + "numericValue": { + "type": "integer", + "description": "A valid numeric response. If paired with a TextValue, the numeric equivalent of the TextValue.", + "minimum": 0, + "maximum": 100 + }, + "textValue": { + "type": "string", + "description": "A valid text response. If paired with a NumericValue, the text equivalent of the NumericValue.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "sortOrder" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "matrices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "minRawScore": { + "type": "integer", + "description": "The minimum score possible on a survey." + }, + "maxRawScore": { + "type": "integer", + "description": "The maximum score possible on a survey." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.surveySectionReference.namespace", + "targetJsonPath": "$.surveyReference.namespace" + }, + { + "sourceJsonPath": "$.surveySectionReference.surveyIdentifier", + "targetJsonPath": "$.surveyReference.surveyIdentifier" + } + ], + "identityFullnames": [ + "QuestionCode", + "Survey" + ], + "documentPathsMapping": { + "QuestionCode": [ + "$.questionCode" + ], + "Survey": [ + "$.surveyReference.namespace", + "$.surveyReference.surveyIdentifier" + ], + "QuestionForm": [ + "$.questionFormDescriptor" + ], + "QuestionText": [ + "$.questionText" + ], + "SurveySection": [ + "$.surveySectionReference.namespace", + "$.surveySectionReference.surveyIdentifier", + "$.surveySectionReference.surveySectionTitle" + ] + } + }, + "surveyQuestionResponses": { + "resourceName": "SurveyQuestionResponse", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestionResponse", + "description": "The response to a survey question.", + "type": "object", + "properties": { + "surveyQuestionReference": { + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "namespace", + "surveyIdentifier" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyQuestionResponseValueIdentifier": { + "type": "integer", + "description": "Primary key for the response value; a unique, usually sequential numeric value for a collection of responses, or potentially the value of NumericResponse for a single response." + }, + "numericResponse": { + "type": "integer", + "description": "A numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "A text response to the question.", + "minLength": 1, + "maxLength": 2048 + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionResponseValueIdentifier" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveyQuestionMatrixElementResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "numericResponse": { + "type": "integer", + "description": "The numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "The text response(s) for the question.", + "minLength": 1, + "maxLength": 2048 + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "minNumericResponse": { + "type": "integer", + "description": "The minimum score response to the question." + }, + "maxNumericResponse": { + "type": "integer", + "description": "The maximum score response to the question." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "comment": { + "type": "string", + "description": "Additional information provided by the responder about the question in the survey.", + "minLength": 1, + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestionResponse", + "description": "The response to a survey question.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyQuestionReference": { + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "namespace", + "surveyIdentifier" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyQuestionResponseValueIdentifier": { + "type": "integer", + "description": "Primary key for the response value; a unique, usually sequential numeric value for a collection of responses, or potentially the value of NumericResponse for a single response." + }, + "numericResponse": { + "type": "integer", + "description": "A numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "A text response to the question.", + "minLength": 1, + "maxLength": 2048 + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionResponseValueIdentifier" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveyQuestionMatrixElementResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "numericResponse": { + "type": "integer", + "description": "The numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "The text response(s) for the question.", + "minLength": 1, + "maxLength": 2048 + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "minNumericResponse": { + "type": "integer", + "description": "The minimum score response to the question." + }, + "maxNumericResponse": { + "type": "integer", + "description": "The maximum score response to the question." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "comment": { + "type": "string", + "description": "Additional information provided by the responder about the question in the survey.", + "minLength": 1, + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyQuestionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyQuestionResponse", + "description": "The response to a survey question.", + "type": "object", + "properties": { + "surveyQuestionReference": { + "type": "object", + "properties": { + "questionCode": { + "type": "string", + "description": "The identifying code for the question, unique for the survey.", + "minLength": 1, + "maxLength": 60 + }, + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "questionCode", + "namespace", + "surveyIdentifier" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyQuestionResponseValueIdentifier": { + "type": "integer", + "description": "Primary key for the response value; a unique, usually sequential numeric value for a collection of responses, or potentially the value of NumericResponse for a single response." + }, + "numericResponse": { + "type": "integer", + "description": "A numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "A text response to the question.", + "minLength": 1, + "maxLength": 2048 + } + }, + "additionalProperties": false, + "required": [ + "surveyQuestionResponseValueIdentifier" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "surveyQuestionMatrixElementResponses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "matrixElement": { + "type": "string", + "description": "For matrix questions, the text identifying each row of the matrix.", + "minLength": 1, + "maxLength": 255 + }, + "numericResponse": { + "type": "integer", + "description": "The numeric response to the question.", + "minimum": 0, + "maximum": 100 + }, + "textResponse": { + "type": "string", + "description": "The text response(s) for the question.", + "minLength": 1, + "maxLength": 2048 + }, + "noResponse": { + "type": "boolean", + "description": "Indicates there was no response to the question." + }, + "minNumericResponse": { + "type": "integer", + "description": "The minimum score response to the question." + }, + "maxNumericResponse": { + "type": "integer", + "description": "The maximum score response to the question." + } + }, + "additionalProperties": false, + "required": [ + "matrixElement" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "comment": { + "type": "string", + "description": "Additional information provided by the responder about the question in the survey.", + "minLength": 1, + "maxLength": 1024 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.surveyResponseReference.namespace", + "targetJsonPath": "$.surveyQuestionReference.namespace" + }, + { + "sourceJsonPath": "$.surveyResponseReference.surveyIdentifier", + "targetJsonPath": "$.surveyQuestionReference.surveyIdentifier" + } + ], + "identityFullnames": [ + "SurveyQuestion", + "SurveyResponse" + ], + "documentPathsMapping": { + "SurveyQuestion": [ + "$.surveyQuestionReference.namespace", + "$.surveyQuestionReference.questionCode", + "$.surveyQuestionReference.surveyIdentifier" + ], + "SurveyResponse": [ + "$.surveyResponseReference.namespace", + "$.surveyResponseReference.surveyIdentifier", + "$.surveyResponseReference.surveyResponseIdentifier" + ], + "NoResponse": [ + "$.noResponse" + ], + "Comment": [ + "$.comment" + ] + } + }, + "surveyResponses": { + "resourceName": "SurveyResponse", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyResponse", + "description": "Responses to a Survey for named or anonymous persons.", + "type": "object", + "properties": { + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "responseDate": { + "type": "string", + "format": "date", + "description": "Date of the survey response." + }, + "responseTime": { + "type": "integer", + "description": "The amount of time (in seconds) it took for the respondent to complete the survey." + }, + "surveyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "surveyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMailAddress": { + "type": "string", + "description": "Email address of the respondent.", + "minLength": 7, + "maxLength": 128 + }, + "fullName": { + "type": "string", + "description": "Full name of the respondent.", + "maxLength": 80 + }, + "location": { + "type": "string", + "description": "Location of the respondent, often a city, district, or school.", + "minLength": 1, + "maxLength": 75 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "contactReference": { + "type": "object", + "properties": { + "contactUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a contact.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyResponseIdentifier", + "surveyReference", + "responseDate" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyResponse", + "description": "Responses to a Survey for named or anonymous persons.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "responseDate": { + "type": "string", + "format": "date", + "description": "Date of the survey response." + }, + "responseTime": { + "type": "integer", + "description": "The amount of time (in seconds) it took for the respondent to complete the survey." + }, + "surveyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "surveyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMailAddress": { + "type": "string", + "description": "Email address of the respondent.", + "minLength": 7, + "maxLength": 128 + }, + "fullName": { + "type": "string", + "description": "Full name of the respondent.", + "maxLength": 80 + }, + "location": { + "type": "string", + "description": "Location of the respondent, often a city, district, or school.", + "minLength": 1, + "maxLength": 75 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "contactReference": { + "type": "object", + "properties": { + "contactUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a contact.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyResponseIdentifier", + "surveyReference", + "responseDate" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveyResponse", + "description": "Responses to a Survey for named or anonymous persons.", + "type": "object", + "properties": { + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "responseDate": { + "type": "string", + "format": "date", + "description": "Date of the survey response." + }, + "responseTime": { + "type": "integer", + "description": "The amount of time (in seconds) it took for the respondent to complete the survey." + }, + "surveyLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "surveyLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "surveyLevelDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "electronicMailAddress": { + "type": "string", + "description": "Email address of the respondent.", + "minLength": 7, + "maxLength": 128 + }, + "fullName": { + "type": "string", + "description": "Full name of the respondent.", + "maxLength": 80 + }, + "location": { + "type": "string", + "description": "Location of the respondent, often a city, district, or school.", + "minLength": 1, + "maxLength": 75 + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "contactReference": { + "type": "object", + "properties": { + "contactUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a contact.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "SurveyResponseIdentifier", + "Survey" + ], + "documentPathsMapping": { + "SurveyResponseIdentifier": [ + "$.surveyResponseIdentifier" + ], + "Survey": [ + "$.surveyReference.namespace", + "$.surveyReference.surveyIdentifier" + ], + "ResponseDate": [ + "$.responseDate" + ], + "ResponseTime": [ + "$.responseTime" + ], + "SurveyLevel": [ + "$.surveyLevels[*].surveyLevelDescriptor" + ], + "ElectronicMailAddress": [ + "$.electronicMailAddress" + ], + "FullName": [ + "$.fullName" + ], + "Location": [ + "$.location" + ] + } + }, + "surveySections": { + "resourceName": "SurveySection", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySection", + "description": "The section of questions for the survey.", + "type": "object", + "properties": { + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveyReference", + "surveySectionTitle" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySection", + "description": "The section of questions for the survey.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveyReference", + "surveySectionTitle" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySection", + "description": "The section of questions for the survey.", + "type": "object", + "properties": { + "surveyReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier" + ] + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Survey", + "SurveySectionTitle" + ], + "documentPathsMapping": { + "Survey": [ + "$.surveyReference.namespace", + "$.surveyReference.surveyIdentifier" + ], + "SurveySectionTitle": [ + "$.surveySectionTitle" + ] + } + }, + "surveySectionResponses": { + "resourceName": "SurveySectionResponse", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySectionResponse", + "description": "Optional information about the responses provided for a section of a survey.", + "type": "object", + "properties": { + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "sectionRating": { + "type": "number", + "description": "Numeric rating computed from the survey responses for the section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "surveySectionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySectionResponse", + "description": "Optional information about the responses provided for a section of a survey.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "sectionRating": { + "type": "number", + "description": "Numeric rating computed from the survey responses for the section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "surveySectionReference", + "surveyResponseReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.SurveySectionResponse", + "description": "Optional information about the responses provided for a section of a survey.", + "type": "object", + "properties": { + "surveySectionReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveySectionTitle": { + "type": "string", + "description": "The title or label for the survey section.", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ] + }, + "surveyResponseReference": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "Namespace for the survey.", + "minLength": 5, + "maxLength": 255 + }, + "surveyIdentifier": { + "type": "string", + "description": "The unique survey identifier from the survey tool.", + "minLength": 1, + "maxLength": 60 + }, + "surveyResponseIdentifier": { + "type": "string", + "description": "The identifier of the survey typically from the survey application.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ] + }, + "sectionRating": { + "type": "number", + "description": "Numeric rating computed from the survey responses for the section." + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [ + { + "sourceJsonPath": "$.surveyResponseReference.namespace", + "targetJsonPath": "$.surveySectionReference.namespace" + }, + { + "sourceJsonPath": "$.surveyResponseReference.surveyIdentifier", + "targetJsonPath": "$.surveySectionReference.surveyIdentifier" + } + ], + "identityFullnames": [ + "SurveySection", + "SurveyResponse" + ], + "documentPathsMapping": { + "SurveySection": [ + "$.surveySectionReference.namespace", + "$.surveySectionReference.surveyIdentifier", + "$.surveySectionReference.surveySectionTitle" + ], + "SurveyResponse": [ + "$.surveyResponseReference.namespace", + "$.surveyResponseReference.surveyIdentifier", + "$.surveyResponseReference.surveyResponseIdentifier" + ], + "SectionRating": [ + "$.sectionRating" + ] + } + }, + "generalStudentProgramAssociations": { + "resourceName": "GeneralStudentProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GeneralStudentProgramAssociation", + "description": "This association base class represents the basic relationship between students and programs.", + "type": "object", + "properties": { + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GeneralStudentProgramAssociation", + "description": "This association base class represents the basic relationship between students and programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.GeneralStudentProgramAssociation", + "description": "This association base class represents the basic relationship between students and programs.", + "type": "object", + "properties": { + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "Student", + "Program", + "BeginDate", + "EducationOrganization" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "communityOrganizations": { + "resourceName": "CommunityOrganization", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityOrganization", + "description": "This entity represents an administrative unit at the state level which exists primarily to operate local community providers.", + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a community organization." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityOrganization", + "description": "This entity represents an administrative unit at the state level which exists primarily to operate local community providers.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a community organization." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "communityOrganizationId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityOrganization", + "description": "This entity represents an administrative unit at the state level which exists primarily to operate local community providers.", + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a community organization." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CommunityOrganizationId" + ], + "documentPathsMapping": { + "CommunityOrganizationId": [ + "$.communityOrganizationId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "communityProviders": { + "resourceName": "CommunityProvider", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProvider", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a community provider." + }, + "communityOrganizationReference": { + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a community organization." + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId" + ] + }, + "providerProfitabilityDescriptor": { + "type": "string", + "description": "Indicates the profitability status of the provider." + }, + "providerStatusDescriptor": { + "type": "string", + "description": "Indicates the status of the provider." + }, + "providerCategoryDescriptor": { + "type": "string", + "description": "Indicates the category of the provider." + }, + "schoolIndicator": { + "type": "boolean", + "description": "An indication of whether the community provider is a school." + }, + "licenseExemptIndicator": { + "type": "boolean", + "description": "An indication of whether the provider is exempt from having a license." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "communityProviderId", + "providerStatusDescriptor", + "providerCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProvider", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a community provider." + }, + "communityOrganizationReference": { + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a community organization." + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId" + ] + }, + "providerProfitabilityDescriptor": { + "type": "string", + "description": "Indicates the profitability status of the provider." + }, + "providerStatusDescriptor": { + "type": "string", + "description": "Indicates the status of the provider." + }, + "providerCategoryDescriptor": { + "type": "string", + "description": "Indicates the category of the provider." + }, + "schoolIndicator": { + "type": "boolean", + "description": "An indication of whether the community provider is a school." + }, + "licenseExemptIndicator": { + "type": "boolean", + "description": "An indication of whether the provider is exempt from having a license." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "communityProviderId", + "providerStatusDescriptor", + "providerCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.CommunityProvider", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "communityProviderId": { + "type": "integer", + "description": "The identifier assigned to a community provider." + }, + "communityOrganizationReference": { + "type": "object", + "properties": { + "communityOrganizationId": { + "type": "integer", + "description": "The identifier assigned to a community organization." + } + }, + "additionalProperties": false, + "required": [ + "communityOrganizationId" + ] + }, + "providerProfitabilityDescriptor": { + "type": "string", + "description": "Indicates the profitability status of the provider." + }, + "providerStatusDescriptor": { + "type": "string", + "description": "Indicates the status of the provider." + }, + "providerCategoryDescriptor": { + "type": "string", + "description": "Indicates the category of the provider." + }, + "schoolIndicator": { + "type": "boolean", + "description": "An indication of whether the community provider is a school." + }, + "licenseExemptIndicator": { + "type": "boolean", + "description": "An indication of whether the provider is exempt from having a license." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "CommunityProviderId" + ], + "documentPathsMapping": { + "CommunityProviderId": [ + "$.communityProviderId" + ], + "CommunityOrganization": [ + "$.communityOrganizationReference.communityOrganizationId" + ], + "ProviderProfitability": [ + "$.providerProfitabilityDescriptor" + ], + "ProviderStatus": [ + "$.providerStatusDescriptor" + ], + "ProviderCategory": [ + "$.providerCategoryDescriptor" + ], + "SchoolIndicator": [ + "$.schoolIndicator" + ], + "LicenseExemptIndicator": [ + "$.licenseExemptIndicator" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "educationOrganizationNetworks": { + "resourceName": "EducationOrganizationNetwork", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationOrganizationNetwork", + "description": "This entity is a self-organized membership network of peer-level education organizations intended to provide shared services or collective procurement.", + "type": "object", + "properties": { + "educationOrganizationNetworkId": { + "type": "integer", + "description": "The identifier assigned to a network of education organizations." + }, + "networkPurposeDescriptor": { + "type": "string", + "description": "The purpose(s) of the network (e.g., shared services, collective procurement)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationNetworkId", + "networkPurposeDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationOrganizationNetwork", + "description": "This entity is a self-organized membership network of peer-level education organizations intended to provide shared services or collective procurement.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationOrganizationNetworkId": { + "type": "integer", + "description": "The identifier assigned to a network of education organizations." + }, + "networkPurposeDescriptor": { + "type": "string", + "description": "The purpose(s) of the network (e.g., shared services, collective procurement)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationOrganizationNetworkId", + "networkPurposeDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationOrganizationNetwork", + "description": "This entity is a self-organized membership network of peer-level education organizations intended to provide shared services or collective procurement.", + "type": "object", + "properties": { + "educationOrganizationNetworkId": { + "type": "integer", + "description": "The identifier assigned to a network of education organizations." + }, + "networkPurposeDescriptor": { + "type": "string", + "description": "The purpose(s) of the network (e.g., shared services, collective procurement)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationOrganizationNetworkId" + ], + "documentPathsMapping": { + "EducationOrganizationNetworkId": [ + "$.educationOrganizationNetworkId" + ], + "NetworkPurpose": [ + "$.networkPurposeDescriptor" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "educationServiceCenters": { + "resourceName": "EducationServiceCenter", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationServiceCenter", + "description": "This entity represents a regional, multi-services public agency authorized by state law to develop, manage and provide services, programs, or other support options (e.g., construction, food services, and technology services) to LEAs.", + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationServiceCenter", + "description": "This entity represents a regional, multi-services public agency authorized by state law to develop, manage and provide services, programs, or other support options (e.g., construction, food services, and technology services) to LEAs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "educationServiceCenterId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.EducationServiceCenter", + "description": "This entity represents a regional, multi-services public agency authorized by state law to develop, manage and provide services, programs, or other support options (e.g., construction, food services, and technology services) to LEAs.", + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "EducationServiceCenterId" + ], + "documentPathsMapping": { + "EducationServiceCenterId": [ + "$.educationServiceCenterId" + ], + "StateEducationAgency": [ + "$.stateEducationAgencyReference.stateEducationAgencyId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "localEducationAgencies": { + "resourceName": "LocalEducationAgency", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEducationAgency", + "description": "This entity represents an administrative unit at the local level which exists primarily to operate schools or to contract for educational services. It includes school districts, charter schools, charter management organizations, or other local administrative organizations.", + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + }, + "localEducationAgencyCategoryDescriptor": { + "type": "string", + "description": "The category of local education agency/district." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "gunFreeSchoolsActReportingStatusDescriptor": { + "type": "string", + "description": "An indication of whether the school or Local Education Agency (LEA) submitted a Gun-Free Schools Act (GFSA) of 1994 report to the state, as defined by Title 18, Section 921." + }, + "schoolChoiceImplementStatusDescriptor": { + "type": "string", + "description": "An indication of whether the LEA was able to implement the provisions for public school choice under Title I, Part A, Section 1116 of ESEA as amended." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "innovativeDollarsSpent": { + "type": "number", + "description": "The total Title V, Part A funds expended by LEAs." + }, + "innovativeDollarsSpentStrategicPriorities": { + "type": "number", + "description": "The total amount of Title V, Part A funds expended by LEAs for the four strategic priorities." + }, + "innovativeProgramsFundsReceived": { + "type": "number", + "description": "The total Title V, Part A funds received by LEAs." + }, + "schoolImprovementAllocation": { + "type": "number", + "description": "The amount of Section 1003(a) and 1003(g) allocations to LEAs." + }, + "schoolImprovementReservedFundsPercentage": { + "type": "number", + "description": "An indication of the percentage of the Title I, Part A allocation that the SEA reserved in accordance with Section 1003(a) of ESEA and 200.100(a) of ED's regulations governing the reservation of funds for school improvement under Section 1003(a) of ESEA." + }, + "supplementalEducationalServicesFundsSpent": { + "type": "number", + "description": "The dollar amount spent on supplemental educational services during the school year under Title I, Part A, Section 1116 of ESEA as amended." + }, + "supplementalEducationalServicesPerPupilExpenditure": { + "type": "number", + "description": "The maximum dollar amount that may be spent per child for expenditures related to supplemental educational services under Title I of the ESEA." + }, + "stateAssessmentAdministrationFunding": { + "type": "number", + "description": "The percentage of funds used to administer assessments required by Section 1111(b) or to carry out other activities described in Section 6111 and other activities related to ensuring that the state's schools and LEAs are held accountable for results." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLocalEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "educationServiceCenterReference": { + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId" + ] + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId", + "localEducationAgencyCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEducationAgency", + "description": "This entity represents an administrative unit at the local level which exists primarily to operate schools or to contract for educational services. It includes school districts, charter schools, charter management organizations, or other local administrative organizations.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + }, + "localEducationAgencyCategoryDescriptor": { + "type": "string", + "description": "The category of local education agency/district." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "gunFreeSchoolsActReportingStatusDescriptor": { + "type": "string", + "description": "An indication of whether the school or Local Education Agency (LEA) submitted a Gun-Free Schools Act (GFSA) of 1994 report to the state, as defined by Title 18, Section 921." + }, + "schoolChoiceImplementStatusDescriptor": { + "type": "string", + "description": "An indication of whether the LEA was able to implement the provisions for public school choice under Title I, Part A, Section 1116 of ESEA as amended." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "innovativeDollarsSpent": { + "type": "number", + "description": "The total Title V, Part A funds expended by LEAs." + }, + "innovativeDollarsSpentStrategicPriorities": { + "type": "number", + "description": "The total amount of Title V, Part A funds expended by LEAs for the four strategic priorities." + }, + "innovativeProgramsFundsReceived": { + "type": "number", + "description": "The total Title V, Part A funds received by LEAs." + }, + "schoolImprovementAllocation": { + "type": "number", + "description": "The amount of Section 1003(a) and 1003(g) allocations to LEAs." + }, + "schoolImprovementReservedFundsPercentage": { + "type": "number", + "description": "An indication of the percentage of the Title I, Part A allocation that the SEA reserved in accordance with Section 1003(a) of ESEA and 200.100(a) of ED's regulations governing the reservation of funds for school improvement under Section 1003(a) of ESEA." + }, + "supplementalEducationalServicesFundsSpent": { + "type": "number", + "description": "The dollar amount spent on supplemental educational services during the school year under Title I, Part A, Section 1116 of ESEA as amended." + }, + "supplementalEducationalServicesPerPupilExpenditure": { + "type": "number", + "description": "The maximum dollar amount that may be spent per child for expenditures related to supplemental educational services under Title I of the ESEA." + }, + "stateAssessmentAdministrationFunding": { + "type": "number", + "description": "The percentage of funds used to administer assessments required by Section 1111(b) or to carry out other activities described in Section 6111 and other activities related to ensuring that the state's schools and LEAs are held accountable for results." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLocalEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "educationServiceCenterReference": { + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId" + ] + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "localEducationAgencyId", + "localEducationAgencyCategoryDescriptor", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.LocalEducationAgency", + "description": "This entity represents an administrative unit at the local level which exists primarily to operate schools or to contract for educational services. It includes school districts, charter schools, charter management organizations, or other local administrative organizations.", + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + }, + "localEducationAgencyCategoryDescriptor": { + "type": "string", + "description": "The category of local education agency/district." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "gunFreeSchoolsActReportingStatusDescriptor": { + "type": "string", + "description": "An indication of whether the school or Local Education Agency (LEA) submitted a Gun-Free Schools Act (GFSA) of 1994 report to the state, as defined by Title 18, Section 921." + }, + "schoolChoiceImplementStatusDescriptor": { + "type": "string", + "description": "An indication of whether the LEA was able to implement the provisions for public school choice under Title I, Part A, Section 1116 of ESEA as amended." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "innovativeDollarsSpent": { + "type": "number", + "description": "The total Title V, Part A funds expended by LEAs." + }, + "innovativeDollarsSpentStrategicPriorities": { + "type": "number", + "description": "The total amount of Title V, Part A funds expended by LEAs for the four strategic priorities." + }, + "innovativeProgramsFundsReceived": { + "type": "number", + "description": "The total Title V, Part A funds received by LEAs." + }, + "schoolImprovementAllocation": { + "type": "number", + "description": "The amount of Section 1003(a) and 1003(g) allocations to LEAs." + }, + "schoolImprovementReservedFundsPercentage": { + "type": "number", + "description": "An indication of the percentage of the Title I, Part A allocation that the SEA reserved in accordance with Section 1003(a) of ESEA and 200.100(a) of ED's regulations governing the reservation of funds for school improvement under Section 1003(a) of ESEA." + }, + "supplementalEducationalServicesFundsSpent": { + "type": "number", + "description": "The dollar amount spent on supplemental educational services during the school year under Title I, Part A, Section 1116 of ESEA as amended." + }, + "supplementalEducationalServicesPerPupilExpenditure": { + "type": "number", + "description": "The maximum dollar amount that may be spent per child for expenditures related to supplemental educational services under Title I of the ESEA." + }, + "stateAssessmentAdministrationFunding": { + "type": "number", + "description": "The percentage of funds used to administer assessments required by Section 1111(b) or to carry out other activities described in Section 6111 and other activities related to ensuring that the state's schools and LEAs are held accountable for results." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "parentLocalEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "educationServiceCenterReference": { + "type": "object", + "properties": { + "educationServiceCenterId": { + "type": "integer", + "description": "The identifier assigned to an education service center." + } + }, + "additionalProperties": false, + "required": [ + "educationServiceCenterId" + ] + }, + "stateEducationAgencyReference": { + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "LocalEducationAgencyId" + ], + "documentPathsMapping": { + "LocalEducationAgencyId": [ + "$.localEducationAgencyId" + ], + "LocalEducationAgencyCategory": [ + "$.localEducationAgencyCategoryDescriptor" + ], + "CharterStatus": [ + "$.charterStatusDescriptor" + ], + "ParentLocalEducationAgency": [ + "$.parentLocalEducationAgencyReference.localEducationAgencyId" + ], + "EducationServiceCenter": [ + "$.educationServiceCenterReference.educationServiceCenterId" + ], + "StateEducationAgency": [ + "$.stateEducationAgencyReference.stateEducationAgencyId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "organizationDepartments": { + "resourceName": "OrganizationDepartment", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OrganizationDepartment", + "description": "An organizational unit of another education organization, often devoted to a particular academic discipline, area of study, or organization function.", + "type": "object", + "properties": { + "organizationDepartmentId": { + "type": "integer", + "description": "The unique identification code for the organization department." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the department." + }, + "parentEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "organizationDepartmentId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OrganizationDepartment", + "description": "An organizational unit of another education organization, often devoted to a particular academic discipline, area of study, or organization function.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "organizationDepartmentId": { + "type": "integer", + "description": "The unique identification code for the organization department." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the department." + }, + "parentEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "organizationDepartmentId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.OrganizationDepartment", + "description": "An organizational unit of another education organization, often devoted to a particular academic discipline, area of study, or organization function.", + "type": "object", + "properties": { + "organizationDepartmentId": { + "type": "integer", + "description": "The unique identification code for the organization department." + }, + "academicSubjectDescriptor": { + "type": "string", + "description": "The intended major subject area of the department." + }, + "parentEducationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "OrganizationDepartmentId" + ], + "documentPathsMapping": { + "OrganizationDepartmentId": [ + "$.organizationDepartmentId" + ], + "AcademicSubject": [ + "$.academicSubjectDescriptor" + ], + "ParentEducationOrganization": [ + "$.parentEducationOrganizationReference.educationOrganizationId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "postSecondaryInstitutions": { + "resourceName": "PostSecondaryInstitution", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryInstitution", + "description": "An organization that provides educational programs for individuals who have completed or otherwise left educational programs in secondary school(s).", + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + }, + "mediumOfInstructions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "mediumOfInstructionDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "postSecondaryInstitutionLevelDescriptor": { + "type": "string", + "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "postSecondaryInstitutionId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryInstitution", + "description": "An organization that provides educational programs for individuals who have completed or otherwise left educational programs in secondary school(s).", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + }, + "mediumOfInstructions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "mediumOfInstructionDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "postSecondaryInstitutionLevelDescriptor": { + "type": "string", + "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "postSecondaryInstitutionId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.PostSecondaryInstitution", + "description": "An organization that provides educational programs for individuals who have completed or otherwise left educational programs in secondary school(s).", + "type": "object", + "properties": { + "postSecondaryInstitutionId": { + "type": "integer", + "description": "The ID of the post secondary institution." + }, + "mediumOfInstructions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "mediumOfInstructionDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "mediumOfInstructionDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "postSecondaryInstitutionLevelDescriptor": { + "type": "string", + "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control)." + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "PostSecondaryInstitutionId" + ], + "documentPathsMapping": { + "PostSecondaryInstitutionId": [ + "$.postSecondaryInstitutionId" + ], + "MediumOfInstruction": [ + "$.mediumOfInstructions[*].mediumOfInstructionDescriptor" + ], + "PostSecondaryInstitutionLevel": [ + "$.postSecondaryInstitutionLevelDescriptor" + ], + "AdministrativeFundingControl": [ + "$.administrativeFundingControlDescriptor" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "schools": { + "resourceName": "School", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.School", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "schoolCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "schoolCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolTypeDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its primary focus." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "titleIPartASchoolDesignationDescriptor": { + "type": "string", + "description": "Denotes the Title I Part A designation for the school." + }, + "magnetSpecialProgramEmphasisSchoolDescriptor": { + "type": "string", + "description": "A school that has been designed: 1) to attract students of different racial/ethnic backgrounds for the purpose of reducing, preventing, or eliminating racial isolation; and/or 2) to provide an academic or social focus on a particular theme (e.g., science/math, performing arts, gifted/talented, or foreign language)." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its funding source, for example public or private." + }, + "internetAccessDescriptor": { + "type": "string", + "description": "The type of Internet access available." + }, + "localEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "charterApprovalAgencyTypeDescriptor": { + "type": "string", + "description": "The type of agency that approved the establishment or continuation of a charter school." + }, + "charterApprovalSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "educationOrganizationCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "schoolId", + "gradeLevels", + "nameOfInstitution", + "educationOrganizationCategories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.School", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "schoolCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "schoolCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolTypeDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its primary focus." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "titleIPartASchoolDesignationDescriptor": { + "type": "string", + "description": "Denotes the Title I Part A designation for the school." + }, + "magnetSpecialProgramEmphasisSchoolDescriptor": { + "type": "string", + "description": "A school that has been designed: 1) to attract students of different racial/ethnic backgrounds for the purpose of reducing, preventing, or eliminating racial isolation; and/or 2) to provide an academic or social focus on a particular theme (e.g., science/math, performing arts, gifted/talented, or foreign language)." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its funding source, for example public or private." + }, + "internetAccessDescriptor": { + "type": "string", + "description": "The type of Internet access available." + }, + "localEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "charterApprovalAgencyTypeDescriptor": { + "type": "string", + "description": "The type of agency that approved the establishment or continuation of a charter school." + }, + "charterApprovalSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "educationOrganizationCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "schoolId", + "gradeLevels", + "nameOfInstitution", + "educationOrganizationCategories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.School", + "description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.", + "type": "object", + "properties": { + "schoolId": { + "type": "integer", + "description": "The identifier assigned to a school." + }, + "gradeLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gradeLevelDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "gradeLevelDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "schoolCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "schoolCategoryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "schoolTypeDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its primary focus." + }, + "charterStatusDescriptor": { + "type": "string", + "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." + }, + "titleIPartASchoolDesignationDescriptor": { + "type": "string", + "description": "Denotes the Title I Part A designation for the school." + }, + "magnetSpecialProgramEmphasisSchoolDescriptor": { + "type": "string", + "description": "A school that has been designed: 1) to attract students of different racial/ethnic backgrounds for the purpose of reducing, preventing, or eliminating racial isolation; and/or 2) to provide an academic or social focus on a particular theme (e.g., science/math, performing arts, gifted/talented, or foreign language)." + }, + "administrativeFundingControlDescriptor": { + "type": "string", + "description": "The type of education institution as classified by its funding source, for example public or private." + }, + "internetAccessDescriptor": { + "type": "string", + "description": "The type of Internet access available." + }, + "localEducationAgencyReference": { + "type": "object", + "properties": { + "localEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a local education agency." + } + }, + "additionalProperties": false, + "required": [ + "localEducationAgencyId" + ] + }, + "charterApprovalAgencyTypeDescriptor": { + "type": "string", + "description": "The type of agency that approved the establishment or continuation of a charter school." + }, + "charterApprovalSchoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "educationOrganizationCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "SchoolId" + ], + "documentPathsMapping": { + "SchoolId": [ + "$.schoolId" + ], + "GradeLevel": [ + "$.gradeLevels[*].gradeLevelDescriptor" + ], + "SchoolCategory": [ + "$.schoolCategories[*].schoolCategoryDescriptor" + ], + "SchoolType": [ + "$.schoolTypeDescriptor" + ], + "CharterStatus": [ + "$.charterStatusDescriptor" + ], + "TitleIPartASchoolDesignation": [ + "$.titleIPartASchoolDesignationDescriptor" + ], + "MagnetSpecialProgramEmphasisSchool": [ + "$.magnetSpecialProgramEmphasisSchoolDescriptor" + ], + "AdministrativeFundingControl": [ + "$.administrativeFundingControlDescriptor" + ], + "InternetAccess": [ + "$.internetAccessDescriptor" + ], + "LocalEducationAgency": [ + "$.localEducationAgencyReference.localEducationAgencyId" + ], + "CharterApprovalAgencyType": [ + "$.charterApprovalAgencyTypeDescriptor" + ], + "CharterApprovalSchoolYear": [ + "$.charterApprovalSchoolYearTypeReference.schoolYear" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.educationOrganizationCategories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "stateEducationAgencies": { + "resourceName": "StateEducationAgency", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StateEducationAgency", + "description": "This entity represents the agency of the state charged with the primary responsibility for coordinating and supervising public instruction, including the setting of standards for elementary and secondary instructional programs.", + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "cteGraduationRateInclusion": { + "type": "boolean", + "description": "An indication of whether CTE concentrators are included in the state's computation of its graduation rate." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "federalProgramsFundingAllocation": { + "type": "number", + "description": "The amount of federal dollars distributed to Local Education Agencies (LEAs), retained by the State Education Agency (SEA) for program administration or other approved state-level activities (including unallocated, transferred to another state agency, or distributed to entities other than LEAs)." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "stateEducationAgencyId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StateEducationAgency", + "description": "This entity represents the agency of the state charged with the primary responsibility for coordinating and supervising public instruction, including the setting of standards for elementary and secondary instructional programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "cteGraduationRateInclusion": { + "type": "boolean", + "description": "An indication of whether CTE concentrators are included in the state's computation of its graduation rate." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "federalProgramsFundingAllocation": { + "type": "number", + "description": "The amount of federal dollars distributed to Local Education Agencies (LEAs), retained by the State Education Agency (SEA) for program administration or other approved state-level activities (including unallocated, transferred to another state agency, or distributed to entities other than LEAs)." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "stateEducationAgencyId", + "nameOfInstitution", + "categories" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StateEducationAgency", + "description": "This entity represents the agency of the state charged with the primary responsibility for coordinating and supervising public instruction, including the setting of standards for elementary and secondary instructional programs.", + "type": "object", + "properties": { + "stateEducationAgencyId": { + "type": "integer", + "description": "The identifier assigned to a state education agency." + }, + "accountabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "cteGraduationRateInclusion": { + "type": "boolean", + "description": "An indication of whether CTE concentrators are included in the state's computation of its graduation rate." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "federalFunds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fiscalYear": { + "type": "integer", + "description": "The fiscal year for which the federal funds are received." + }, + "federalProgramsFundingAllocation": { + "type": "number", + "description": "The amount of federal dollars distributed to Local Education Agencies (LEAs), retained by the State Education Agency (SEA) for program administration or other approved state-level activities (including unallocated, transferred to another state agency, or distributed to entities other than LEAs)." + } + }, + "additionalProperties": false, + "required": [ + "fiscalYear" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "identificationCodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "identificationCode": { + "type": "string", + "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.", + "minLength": 1, + "maxLength": 60 + }, + "educationOrganizationIdentificationSystemDescriptor": { + "type": "string", + "description": "The school system, state, or agency assigning the identification code." + } + }, + "additionalProperties": false, + "required": [ + "identificationCode", + "educationOrganizationIdentificationSystemDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "nameOfInstitution": { + "type": "string", + "description": "The full, legally accepted name of the institution.", + "minLength": 1, + "maxLength": 75 + }, + "shortNameOfInstitution": { + "type": "string", + "description": "A short name for the institution.", + "minLength": 1, + "maxLength": 75 + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "educationOrganizationCategoryDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationCategoryDescriptor" + ] + }, + "minItems": 1, + "uniqueItems": false + }, + "addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "streetNumberName": { + "type": "string", + "description": "The street number and street name or post office box number of an address.", + "minLength": 1, + "maxLength": 150 + }, + "apartmentRoomSuiteNumber": { + "type": "string", + "description": "The apartment, room, or suite number of an address.", + "minLength": 1, + "maxLength": 50 + }, + "buildingSiteNumber": { + "type": "string", + "description": "The number of the building on the site, if more than one building shares the same address.", + "minLength": 1, + "maxLength": 20 + }, + "city": { + "type": "string", + "description": "The name of the city in which an address is located.", + "minLength": 2, + "maxLength": 30 + }, + "stateAbbreviationDescriptor": { + "type": "string", + "description": "The abbreviation for the state (within the United States) or outlying area in which an address is located." + }, + "postalCode": { + "type": "string", + "description": "The five or nine digit zip code or overseas postal code portion of an address.", + "minLength": 1, + "maxLength": 17 + }, + "nameOfCounty": { + "type": "string", + "description": "The name of the county, parish, borough, or comparable unit (within a state) in 'which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "countyFIPSCode": { + "type": "string", + "description": "The Federal Information Processing Standards (FIPS) numeric code for the county issued by the National Institute of Standards and Technology (NIST). Counties are considered to be the \"first-order subdivisions\" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.) Counties in different States will have the same code. A unique county number is created when combined with the 2-digit FIPS State Code.", + "minLength": 3, + "maxLength": 5 + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "doNotPublishIndicator": { + "type": "boolean", + "description": "An indication that the address should not be published." + }, + "congressionalDistrict": { + "type": "string", + "description": "The congressional district in which an address is located.", + "minLength": 1, + "maxLength": 30 + }, + "localeDescriptor": { + "type": "string", + "description": "A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)." + } + }, + "additionalProperties": false, + "required": [ + "streetNumberName", + "city", + "stateAbbreviationDescriptor", + "postalCode", + "addressTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "internationalAddresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "addressTypeDescriptor": { + "type": "string", + "description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)" + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine2": { + "type": "string", + "description": "The second line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine3": { + "type": "string", + "description": "The third line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "addressLine4": { + "type": "string", + "description": "The fourth line of the address.", + "minLength": 1, + "maxLength": 150 + }, + "countryDescriptor": { + "type": "string", + "description": "The name of the country. It is strongly recommended that entries use only ISO 3166 2-letter country codes." + }, + "latitude": { + "type": "string", + "description": "The geographic latitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "longitude": { + "type": "string", + "description": "The geographic longitude of the physical address.", + "minLength": 1, + "maxLength": 20 + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The first date the address is valid. For physical addresses, the date the individual moved to that address." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The last date the address is valid. For physical addresses, the date the individual moved from that address." + } + }, + "additionalProperties": false, + "required": [ + "addressTypeDescriptor", + "addressLine1", + "countryDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "institutionTelephones": { + "type": "array", + "items": { + "type": "object", + "properties": { + "telephoneNumber": { + "type": "string", + "description": "The telephone number including the area code, and extension, if applicable.", + "minLength": 1, + "maxLength": 24 + }, + "institutionTelephoneNumberTypeDescriptor": { + "type": "string", + "description": "The type of communication number listed for an individual or organization." + } + }, + "additionalProperties": false, + "required": [ + "telephoneNumber", + "institutionTelephoneNumberTypeDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "webSite": { + "type": "string", + "description": "The public web site address (URL) for the education organization.", + "minLength": 5, + "maxLength": 255 + }, + "operationalStatusDescriptor": { + "type": "string", + "description": "The current operational status of the education organization (e.g., active, inactive)." + }, + "indicators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "indicatorDescriptor": { + "type": "string", + "description": "The name or code for the indicator or metric." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that defined the metric.", + "minLength": 1, + "maxLength": 60 + }, + "indicatorValue": { + "type": "string", + "description": "The value of the indicator or metric. The semantics of an empty value is \"not submitted.\"", + "minLength": 1, + "maxLength": 60 + }, + "indicatorLevelDescriptor": { + "type": "string", + "description": "The value of the indicator or metric, as a value from a controlled vocabulary. The semantics of an empty value is \"not submitted.\"" + }, + "indicatorGroupDescriptor": { + "type": "string", + "description": "The name for a group of indicators." + }, + "periods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "beginDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the start of the period." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year for the end of the period." + } + }, + "additionalProperties": false, + "required": [ + "beginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "indicatorDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "StateEducationAgencyId" + ], + "documentPathsMapping": { + "StateEducationAgencyId": [ + "$.stateEducationAgencyId" + ], + "NameOfInstitution": [ + "$.nameOfInstitution" + ], + "ShortNameOfInstitution": [ + "$.shortNameOfInstitution" + ], + "EducationOrganizationCategory": [ + "$.categories[*].educationOrganizationCategoryDescriptor" + ], + "WebSite": [ + "$.webSite" + ], + "OperationalStatus": [ + "$.operationalStatusDescriptor" + ] + } + }, + "studentCTEProgramAssociations": { + "resourceName": "StudentCTEProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCTEProgramAssociation", + "description": "This association represents the career and technical education (CTE) program that a student participates in. The association is an extension of the StudentProgramAssociation particular for CTE programs.", + "type": "object", + "properties": { + "nonTraditionalGenderStatus": { + "type": "boolean", + "description": "Indicator that student is from a gender group that comprises less than 25% of the individuals employed in an occupation or field of work." + }, + "privateCTEProgram": { + "type": "boolean", + "description": "Indicator that student participated in career and technical education at private agencies or institutions that are reported by the state for purposes of the Elementary and Secondary Education Act (ESEA). Students in private institutions which do not receive Perkins funding are reported only in the state file." + }, + "technicalSkillsAssessmentDescriptor": { + "type": "string", + "description": "Results of technical skills assessment aligned with industry recognized standards." + }, + "cteProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cteProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the CTE program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP code associated with the student's CTE program.", + "minLength": 1, + "maxLength": 120 + } + }, + "additionalProperties": false, + "required": [ + "cteProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCTEProgramAssociation", + "description": "This association represents the career and technical education (CTE) program that a student participates in. The association is an extension of the StudentProgramAssociation particular for CTE programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "nonTraditionalGenderStatus": { + "type": "boolean", + "description": "Indicator that student is from a gender group that comprises less than 25% of the individuals employed in an occupation or field of work." + }, + "privateCTEProgram": { + "type": "boolean", + "description": "Indicator that student participated in career and technical education at private agencies or institutions that are reported by the state for purposes of the Elementary and Secondary Education Act (ESEA). Students in private institutions which do not receive Perkins funding are reported only in the state file." + }, + "technicalSkillsAssessmentDescriptor": { + "type": "string", + "description": "Results of technical skills assessment aligned with industry recognized standards." + }, + "cteProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cteProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the CTE program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP code associated with the student's CTE program.", + "minLength": 1, + "maxLength": 120 + } + }, + "additionalProperties": false, + "required": [ + "cteProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentCTEProgramAssociation", + "description": "This association represents the career and technical education (CTE) program that a student participates in. The association is an extension of the StudentProgramAssociation particular for CTE programs.", + "type": "object", + "properties": { + "nonTraditionalGenderStatus": { + "type": "boolean", + "description": "Indicator that student is from a gender group that comprises less than 25% of the individuals employed in an occupation or field of work." + }, + "privateCTEProgram": { + "type": "boolean", + "description": "Indicator that student participated in career and technical education at private agencies or institutions that are reported by the state for purposes of the Elementary and Secondary Education Act (ESEA). Students in private institutions which do not receive Perkins funding are reported only in the state file." + }, + "technicalSkillsAssessmentDescriptor": { + "type": "string", + "description": "Results of technical skills assessment aligned with industry recognized standards." + }, + "cteProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cteProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the CTE program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + }, + "cipCode": { + "type": "string", + "description": "Number and description of the CIP code associated with the student's CTE program.", + "minLength": 1, + "maxLength": 120 + } + }, + "additionalProperties": false, + "required": [ + "cteProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "NonTraditionalGenderStatus": [ + "$.nonTraditionalGenderStatus" + ], + "PrivateCTEProgram": [ + "$.privateCTEProgram" + ], + "TechnicalSkillsAssessment": [ + "$.technicalSkillsAssessmentDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentHomelessProgramAssociations": { + "resourceName": "StudentHomelessProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentHomelessProgramAssociation", + "description": "This association represents the McKinney-Vento Homeless Program program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "homelessPrimaryNighttimeResidenceDescriptor": { + "type": "string", + "description": "The primary nighttime residence of the student at the time the student is identified as homeless." + }, + "awaitingFosterCare": { + "type": "boolean", + "description": "State defined definition for awaiting foster care." + }, + "homelessUnaccompaniedYouth": { + "type": "boolean", + "description": "A homeless unaccompanied youth is a youth who is not in the physical custody of a parent or guardian and who fits the McKinney-Vento definition of homeless. Students must be both unaccompanied and homeless to be included as an unaccompanied homeless youth." + }, + "homelessProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "homelessProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the homeless program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "homelessProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentHomelessProgramAssociation", + "description": "This association represents the McKinney-Vento Homeless Program program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "homelessPrimaryNighttimeResidenceDescriptor": { + "type": "string", + "description": "The primary nighttime residence of the student at the time the student is identified as homeless." + }, + "awaitingFosterCare": { + "type": "boolean", + "description": "State defined definition for awaiting foster care." + }, + "homelessUnaccompaniedYouth": { + "type": "boolean", + "description": "A homeless unaccompanied youth is a youth who is not in the physical custody of a parent or guardian and who fits the McKinney-Vento definition of homeless. Students must be both unaccompanied and homeless to be included as an unaccompanied homeless youth." + }, + "homelessProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "homelessProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the homeless program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "homelessProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentHomelessProgramAssociation", + "description": "This association represents the McKinney-Vento Homeless Program program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "homelessPrimaryNighttimeResidenceDescriptor": { + "type": "string", + "description": "The primary nighttime residence of the student at the time the student is identified as homeless." + }, + "awaitingFosterCare": { + "type": "boolean", + "description": "State defined definition for awaiting foster care." + }, + "homelessUnaccompaniedYouth": { + "type": "boolean", + "description": "A homeless unaccompanied youth is a youth who is not in the physical custody of a parent or guardian and who fits the McKinney-Vento definition of homeless. Students must be both unaccompanied and homeless to be included as an unaccompanied homeless youth." + }, + "homelessProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "homelessProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the homeless program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "homelessProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "HomelessPrimaryNighttimeResidence": [ + "$.homelessPrimaryNighttimeResidenceDescriptor" + ], + "AwaitingFosterCare": [ + "$.awaitingFosterCare" + ], + "HomelessUnaccompaniedYouth": [ + "$.homelessUnaccompaniedYouth" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentLanguageInstructionProgramAssociations": { + "resourceName": "StudentLanguageInstructionProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLanguageInstructionProgramAssociation", + "description": "This association represents the Title III Language Instruction for Limited English Proficient and Immigrant Students program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "englishLanguageProficiencyAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "participationDescriptor": { + "type": "string", + "description": "Field indicating the participation in the yearly English language assessment." + }, + "proficiencyDescriptor": { + "type": "string", + "description": "The proficiency level for the yearly English language assessment." + }, + "progressDescriptor": { + "type": "string", + "description": "The yearly progress or growth from last year's assessment." + }, + "monitoredDescriptor": { + "type": "string", + "description": "Student is monitored on content achievement who are no longer receiving services." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "englishLearnerParticipation": { + "type": "boolean", + "description": "An indication that an English learner student is served by an English language instruction educational program supported with Title III of ESEA funds." + }, + "languageInstructionProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageInstructionProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the language instruction program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "languageInstructionProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "dosage": { + "type": "integer", + "description": "The duration of time in minutes for which the student was assigned to participate in the program." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLanguageInstructionProgramAssociation", + "description": "This association represents the Title III Language Instruction for Limited English Proficient and Immigrant Students program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "englishLanguageProficiencyAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "participationDescriptor": { + "type": "string", + "description": "Field indicating the participation in the yearly English language assessment." + }, + "proficiencyDescriptor": { + "type": "string", + "description": "The proficiency level for the yearly English language assessment." + }, + "progressDescriptor": { + "type": "string", + "description": "The yearly progress or growth from last year's assessment." + }, + "monitoredDescriptor": { + "type": "string", + "description": "Student is monitored on content achievement who are no longer receiving services." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "englishLearnerParticipation": { + "type": "boolean", + "description": "An indication that an English learner student is served by an English language instruction educational program supported with Title III of ESEA funds." + }, + "languageInstructionProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageInstructionProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the language instruction program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "languageInstructionProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "dosage": { + "type": "integer", + "description": "The duration of time in minutes for which the student was assigned to participate in the program." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentLanguageInstructionProgramAssociation", + "description": "This association represents the Title III Language Instruction for Limited English Proficient and Immigrant Students program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "englishLanguageProficiencyAssessments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolYearTypeReference": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.SchoolYearType", + "description": "A school year enumeration", + "type": "object", + "properties": { + "schoolYear": { + "type": "integer", + "description": "A school year between 1900 and 2100", + "minimum": 1900, + "maximum": 2100 + } + }, + "additionalProperties": false + }, + "participationDescriptor": { + "type": "string", + "description": "Field indicating the participation in the yearly English language assessment." + }, + "proficiencyDescriptor": { + "type": "string", + "description": "The proficiency level for the yearly English language assessment." + }, + "progressDescriptor": { + "type": "string", + "description": "The yearly progress or growth from last year's assessment." + }, + "monitoredDescriptor": { + "type": "string", + "description": "Student is monitored on content achievement who are no longer receiving services." + } + }, + "additionalProperties": false, + "required": [ + "schoolYearTypeReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "englishLearnerParticipation": { + "type": "boolean", + "description": "An indication that an English learner student is served by an English language instruction educational program supported with Title III of ESEA funds." + }, + "languageInstructionProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "languageInstructionProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the language instruction program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "languageInstructionProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "dosage": { + "type": "integer", + "description": "The duration of time in minutes for which the student was assigned to participate in the program." + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "EnglishLearnerParticipation": [ + "$.englishLearnerParticipation" + ], + "Dosage": [ + "$.dosage" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentMigrantEducationProgramAssociations": { + "resourceName": "StudentMigrantEducationProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentMigrantEducationProgramAssociation", + "description": "This association represents the migrant education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation with added elements particular to migrant education programs.", + "type": "object", + "properties": { + "priorityForServices": { + "type": "boolean", + "description": "Report migratory children who are classified as having \"priority for services\" because they are failing, or most at risk of failing to meet the state's challenging state academic content standards and challenging state student academic achievement standards, and their education has been interrupted during the regular school year." + }, + "lastQualifyingMove": { + "type": "string", + "format": "date", + "description": "Date the last qualifying move occurred; used to compute MEP status." + }, + "continuationOfServicesReasonDescriptor": { + "type": "string", + "description": "The \"continuation of services\" provision found in Section 1304(e) of the statute provides that (1) a child who ceases to be a migratory child during a school term shall be eligible for services until the end of such term; (2) a child who is no longer a migratory child may continue to receive services for one additional school year, but only if comparable services are not available through other programs; and (3) secondary school students who were eligible for services in secondary school may continue to be served through credit accrual programs until graduation. Only students who received services at any time during their 36 month eligibility period may continue to receive services (not necessarily the same service)." + }, + "usInitialEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student first entered the U.S." + }, + "usMostRecentEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the student's most recent entry into the U.S." + }, + "usInitialSchoolEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student first entered a U.S. school." + }, + "qualifyingArrivalDate": { + "type": "string", + "format": "date", + "description": "The qualifying arrival date (QAD) is the date the child joins the worker who has already moved, or the date when the worker joins the child who has already moved. The QAD is the date that the child's eligibility for the MEP begins. The QAD is not affected by subsequent non-qualifying moves." + }, + "stateResidencyDate": { + "type": "string", + "format": "date", + "description": "The verified state residency for the student." + }, + "eligibilityExpirationDate": { + "type": "string", + "format": "date", + "description": "The eligibility expiration date is used to determine end of eligibility and to account for a child's eligibility expiring earlier than 36 months from the child's QAD. A child's eligibility would end earlier than 36 months from the child's QAD, if the child is no longer entitled to a free public education (e.g., graduated with a high school diploma, obtained a high school equivalency diploma (HSED), or for other reasons as determined by states' requirements), or if the child passes away." + }, + "migrantEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "migrantEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the migrant education program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "migrantEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "priorityForServices", + "lastQualifyingMove", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentMigrantEducationProgramAssociation", + "description": "This association represents the migrant education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation with added elements particular to migrant education programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "priorityForServices": { + "type": "boolean", + "description": "Report migratory children who are classified as having \"priority for services\" because they are failing, or most at risk of failing to meet the state's challenging state academic content standards and challenging state student academic achievement standards, and their education has been interrupted during the regular school year." + }, + "lastQualifyingMove": { + "type": "string", + "format": "date", + "description": "Date the last qualifying move occurred; used to compute MEP status." + }, + "continuationOfServicesReasonDescriptor": { + "type": "string", + "description": "The \"continuation of services\" provision found in Section 1304(e) of the statute provides that (1) a child who ceases to be a migratory child during a school term shall be eligible for services until the end of such term; (2) a child who is no longer a migratory child may continue to receive services for one additional school year, but only if comparable services are not available through other programs; and (3) secondary school students who were eligible for services in secondary school may continue to be served through credit accrual programs until graduation. Only students who received services at any time during their 36 month eligibility period may continue to receive services (not necessarily the same service)." + }, + "usInitialEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student first entered the U.S." + }, + "usMostRecentEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the student's most recent entry into the U.S." + }, + "usInitialSchoolEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student first entered a U.S. school." + }, + "qualifyingArrivalDate": { + "type": "string", + "format": "date", + "description": "The qualifying arrival date (QAD) is the date the child joins the worker who has already moved, or the date when the worker joins the child who has already moved. The QAD is the date that the child's eligibility for the MEP begins. The QAD is not affected by subsequent non-qualifying moves." + }, + "stateResidencyDate": { + "type": "string", + "format": "date", + "description": "The verified state residency for the student." + }, + "eligibilityExpirationDate": { + "type": "string", + "format": "date", + "description": "The eligibility expiration date is used to determine end of eligibility and to account for a child's eligibility expiring earlier than 36 months from the child's QAD. A child's eligibility would end earlier than 36 months from the child's QAD, if the child is no longer entitled to a free public education (e.g., graduated with a high school diploma, obtained a high school equivalency diploma (HSED), or for other reasons as determined by states' requirements), or if the child passes away." + }, + "migrantEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "migrantEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the migrant education program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "migrantEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "priorityForServices", + "lastQualifyingMove", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentMigrantEducationProgramAssociation", + "description": "This association represents the migrant education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation with added elements particular to migrant education programs.", + "type": "object", + "properties": { + "priorityForServices": { + "type": "boolean", + "description": "Report migratory children who are classified as having \"priority for services\" because they are failing, or most at risk of failing to meet the state's challenging state academic content standards and challenging state student academic achievement standards, and their education has been interrupted during the regular school year." + }, + "lastQualifyingMove": { + "type": "string", + "format": "date", + "description": "Date the last qualifying move occurred; used to compute MEP status." + }, + "continuationOfServicesReasonDescriptor": { + "type": "string", + "description": "The \"continuation of services\" provision found in Section 1304(e) of the statute provides that (1) a child who ceases to be a migratory child during a school term shall be eligible for services until the end of such term; (2) a child who is no longer a migratory child may continue to receive services for one additional school year, but only if comparable services are not available through other programs; and (3) secondary school students who were eligible for services in secondary school may continue to be served through credit accrual programs until graduation. Only students who received services at any time during their 36 month eligibility period may continue to receive services (not necessarily the same service)." + }, + "usInitialEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student first entered the U.S." + }, + "usMostRecentEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year of the student's most recent entry into the U.S." + }, + "usInitialSchoolEntry": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student first entered a U.S. school." + }, + "qualifyingArrivalDate": { + "type": "string", + "format": "date", + "description": "The qualifying arrival date (QAD) is the date the child joins the worker who has already moved, or the date when the worker joins the child who has already moved. The QAD is the date that the child's eligibility for the MEP begins. The QAD is not affected by subsequent non-qualifying moves." + }, + "stateResidencyDate": { + "type": "string", + "format": "date", + "description": "The verified state residency for the student." + }, + "eligibilityExpirationDate": { + "type": "string", + "format": "date", + "description": "The eligibility expiration date is used to determine end of eligibility and to account for a child's eligibility expiring earlier than 36 months from the child's QAD. A child's eligibility would end earlier than 36 months from the child's QAD, if the child is no longer entitled to a free public education (e.g., graduated with a high school diploma, obtained a high school equivalency diploma (HSED), or for other reasons as determined by states' requirements), or if the child passes away." + }, + "migrantEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "migrantEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the migrant education program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "migrantEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "PriorityForServices": [ + "$.priorityForServices" + ], + "LastQualifyingMove": [ + "$.lastQualifyingMove" + ], + "ContinuationOfServicesReason": [ + "$.continuationOfServicesReasonDescriptor" + ], + "USInitialEntry": [ + "$.usInitialEntry" + ], + "USMostRecentEntry": [ + "$.usMostRecentEntry" + ], + "USInitialSchoolEntry": [ + "$.usInitialSchoolEntry" + ], + "QualifyingArrivalDate": [ + "$.qualifyingArrivalDate" + ], + "StateResidencyDate": [ + "$.stateResidencyDate" + ], + "EligibilityExpirationDate": [ + "$.eligibilityExpirationDate" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentNeglectedOrDelinquentProgramAssociations": { + "resourceName": "StudentNeglectedOrDelinquentProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentNeglectedOrDelinquentProgramAssociation", + "description": "This association represents the Title I Part D Neglected or Delinquent program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "neglectedOrDelinquentProgramDescriptor": { + "type": "string", + "description": "The type of program under ESEA Title I, Part D, Subpart 1 (state programs) or Subpart 2 (LEA)." + }, + "elaProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post- test for ELA." + }, + "mathematicsProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post-test for Mathematics." + }, + "neglectedOrDelinquentProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "neglectedOrDelinquentProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the neglected or delinquent program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "neglectedOrDelinquentProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentNeglectedOrDelinquentProgramAssociation", + "description": "This association represents the Title I Part D Neglected or Delinquent program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "neglectedOrDelinquentProgramDescriptor": { + "type": "string", + "description": "The type of program under ESEA Title I, Part D, Subpart 1 (state programs) or Subpart 2 (LEA)." + }, + "elaProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post- test for ELA." + }, + "mathematicsProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post-test for Mathematics." + }, + "neglectedOrDelinquentProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "neglectedOrDelinquentProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the neglected or delinquent program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "neglectedOrDelinquentProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentNeglectedOrDelinquentProgramAssociation", + "description": "This association represents the Title I Part D Neglected or Delinquent program(s) that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "neglectedOrDelinquentProgramDescriptor": { + "type": "string", + "description": "The type of program under ESEA Title I, Part D, Subpart 1 (state programs) or Subpart 2 (LEA)." + }, + "elaProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post- test for ELA." + }, + "mathematicsProgressLevelDescriptor": { + "type": "string", + "description": "The progress measured from pre- to post-test for Mathematics." + }, + "neglectedOrDelinquentProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "neglectedOrDelinquentProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the neglected or delinquent program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "neglectedOrDelinquentProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "NeglectedOrDelinquentProgram": [ + "$.neglectedOrDelinquentProgramDescriptor" + ], + "ELAProgressLevel": [ + "$.elaProgressLevelDescriptor" + ], + "MathematicsProgressLevel": [ + "$.mathematicsProgressLevelDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentProgramAssociations": { + "resourceName": "StudentProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAssociation", + "description": "This association represents the program(s) that a student participates in or is served by.", + "type": "object", + "properties": { + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAssociation", + "description": "This association represents the program(s) that a student participates in or is served by.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentProgramAssociation", + "description": "This association represents the program(s) that a student participates in or is served by.", + "type": "object", + "properties": { + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serviceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "serviceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentSchoolFoodServiceProgramAssociations": { + "resourceName": "StudentSchoolFoodServiceProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolFoodServiceProgramAssociation", + "description": "This association represents the school food services program(s), such as the Free or Reduced Lunch program, that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "directCertification": { + "type": "boolean", + "description": "Indicates that the student's National School Lunch Program (NSLP) eligibility has been determined through direct certification." + }, + "schoolFoodServiceProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolFoodServiceProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the school food service program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "schoolFoodServiceProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolFoodServiceProgramAssociation", + "description": "This association represents the school food services program(s), such as the Free or Reduced Lunch program, that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "directCertification": { + "type": "boolean", + "description": "Indicates that the student's National School Lunch Program (NSLP) eligibility has been determined through direct certification." + }, + "schoolFoodServiceProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolFoodServiceProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the school food service program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "schoolFoodServiceProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSchoolFoodServiceProgramAssociation", + "description": "This association represents the school food services program(s), such as the Free or Reduced Lunch program, that a student participates in or from which the student receives services.", + "type": "object", + "properties": { + "directCertification": { + "type": "boolean", + "description": "Indicates that the student's National School Lunch Program (NSLP) eligibility has been determined through direct certification." + }, + "schoolFoodServiceProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schoolFoodServiceProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the school food service program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "schoolFoodServiceProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "DirectCertification": [ + "$.directCertification" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentSpecialEducationProgramAssociations": { + "resourceName": "StudentSpecialEducationProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSpecialEducationProgramAssociation", + "description": "This association represents the special education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation particular for special education programs.", + "type": "object", + "properties": { + "ideaEligibility": { + "type": "boolean", + "description": "Indicator of the eligibility of the student to receive special education services according to the Individuals with Disabilities Education Act (IDEA)." + }, + "specialEducationSettingDescriptor": { + "type": "string", + "description": "The major instructional setting (more than 50 percent of a student's special education program)." + }, + "serviceProviders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationHoursPerWeek": { + "type": "number", + "description": "The number of hours per week for special education instruction and therapy." + }, + "schoolHoursPerWeek": { + "type": "number", + "description": "Indicate the total number of hours of instructional time per week for the school that the student attends." + }, + "multiplyDisabled": { + "type": "boolean", + "description": "Indicates whether the student receiving special education and related services has been designated as multiply disabled by the admission, review, and dismissal committee as aligned with federal requirements." + }, + "medicallyFragile": { + "type": "boolean", + "description": "Indicates whether the student receiving special education and related services is: 1) in the age range of birth to 22 years, and 2) has a serious, ongoing illness or a chronic condition that has lasted or is anticipated to last at least 12 or more months or has required at least one month of hospitalization, and that requires daily, ongoing medical treatments and monitoring by appropriately trained personnel which may include parents or other family members, and 3) requires the routine use of medical device or of assistive technology to compensate for the loss of usefulness of a body function needed to participate in activities of daily living, and 4) lives with ongoing threat to his or her continued well-being. Aligns with federal requirements." + }, + "lastEvaluationDate": { + "type": "string", + "format": "date", + "description": "The date of the last special education evaluation." + }, + "iepReviewDate": { + "type": "string", + "format": "date", + "description": "The date of the last IEP review." + }, + "iepBeginDate": { + "type": "string", + "format": "date", + "description": "The effective date of the most recent IEP." + }, + "iepEndDate": { + "type": "string", + "format": "date", + "description": "The end date of the most recent IEP." + }, + "disabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDescriptor": { + "type": "string", + "description": "A disability category that describes a individual's impairment." + }, + "disabilityDiagnosis": { + "type": "string", + "description": "A description of the disability diagnosis.", + "minLength": 1, + "maxLength": 80 + }, + "orderOfDisability": { + "type": "integer", + "description": "The order by severity of individual's disabilities: 1- Primary, 2 - Secondary, 3 - Tertiary, etc." + }, + "disabilityDeterminationSourceTypeDescriptor": { + "type": "string", + "description": "The source that provided the disability determination." + }, + "designations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDesignationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disabilityDesignationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "disabilityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the special education program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + }, + "providers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "specialEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSpecialEducationProgramAssociation", + "description": "This association represents the special education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation particular for special education programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "ideaEligibility": { + "type": "boolean", + "description": "Indicator of the eligibility of the student to receive special education services according to the Individuals with Disabilities Education Act (IDEA)." + }, + "specialEducationSettingDescriptor": { + "type": "string", + "description": "The major instructional setting (more than 50 percent of a student's special education program)." + }, + "serviceProviders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationHoursPerWeek": { + "type": "number", + "description": "The number of hours per week for special education instruction and therapy." + }, + "schoolHoursPerWeek": { + "type": "number", + "description": "Indicate the total number of hours of instructional time per week for the school that the student attends." + }, + "multiplyDisabled": { + "type": "boolean", + "description": "Indicates whether the student receiving special education and related services has been designated as multiply disabled by the admission, review, and dismissal committee as aligned with federal requirements." + }, + "medicallyFragile": { + "type": "boolean", + "description": "Indicates whether the student receiving special education and related services is: 1) in the age range of birth to 22 years, and 2) has a serious, ongoing illness or a chronic condition that has lasted or is anticipated to last at least 12 or more months or has required at least one month of hospitalization, and that requires daily, ongoing medical treatments and monitoring by appropriately trained personnel which may include parents or other family members, and 3) requires the routine use of medical device or of assistive technology to compensate for the loss of usefulness of a body function needed to participate in activities of daily living, and 4) lives with ongoing threat to his or her continued well-being. Aligns with federal requirements." + }, + "lastEvaluationDate": { + "type": "string", + "format": "date", + "description": "The date of the last special education evaluation." + }, + "iepReviewDate": { + "type": "string", + "format": "date", + "description": "The date of the last IEP review." + }, + "iepBeginDate": { + "type": "string", + "format": "date", + "description": "The effective date of the most recent IEP." + }, + "iepEndDate": { + "type": "string", + "format": "date", + "description": "The end date of the most recent IEP." + }, + "disabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDescriptor": { + "type": "string", + "description": "A disability category that describes a individual's impairment." + }, + "disabilityDiagnosis": { + "type": "string", + "description": "A description of the disability diagnosis.", + "minLength": 1, + "maxLength": 80 + }, + "orderOfDisability": { + "type": "integer", + "description": "The order by severity of individual's disabilities: 1- Primary, 2 - Secondary, 3 - Tertiary, etc." + }, + "disabilityDeterminationSourceTypeDescriptor": { + "type": "string", + "description": "The source that provided the disability determination." + }, + "designations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDesignationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disabilityDesignationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "disabilityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the special education program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + }, + "providers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "specialEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentSpecialEducationProgramAssociation", + "description": "This association represents the special education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation particular for special education programs.", + "type": "object", + "properties": { + "ideaEligibility": { + "type": "boolean", + "description": "Indicator of the eligibility of the student to receive special education services according to the Individuals with Disabilities Education Act (IDEA)." + }, + "specialEducationSettingDescriptor": { + "type": "string", + "description": "The major instructional setting (more than 50 percent of a student's special education program)." + }, + "serviceProviders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationHoursPerWeek": { + "type": "number", + "description": "The number of hours per week for special education instruction and therapy." + }, + "schoolHoursPerWeek": { + "type": "number", + "description": "Indicate the total number of hours of instructional time per week for the school that the student attends." + }, + "multiplyDisabled": { + "type": "boolean", + "description": "Indicates whether the student receiving special education and related services has been designated as multiply disabled by the admission, review, and dismissal committee as aligned with federal requirements." + }, + "medicallyFragile": { + "type": "boolean", + "description": "Indicates whether the student receiving special education and related services is: 1) in the age range of birth to 22 years, and 2) has a serious, ongoing illness or a chronic condition that has lasted or is anticipated to last at least 12 or more months or has required at least one month of hospitalization, and that requires daily, ongoing medical treatments and monitoring by appropriately trained personnel which may include parents or other family members, and 3) requires the routine use of medical device or of assistive technology to compensate for the loss of usefulness of a body function needed to participate in activities of daily living, and 4) lives with ongoing threat to his or her continued well-being. Aligns with federal requirements." + }, + "lastEvaluationDate": { + "type": "string", + "format": "date", + "description": "The date of the last special education evaluation." + }, + "iepReviewDate": { + "type": "string", + "format": "date", + "description": "The date of the last IEP review." + }, + "iepBeginDate": { + "type": "string", + "format": "date", + "description": "The effective date of the most recent IEP." + }, + "iepEndDate": { + "type": "string", + "format": "date", + "description": "The end date of the most recent IEP." + }, + "disabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDescriptor": { + "type": "string", + "description": "A disability category that describes a individual's impairment." + }, + "disabilityDiagnosis": { + "type": "string", + "description": "A description of the disability diagnosis.", + "minLength": 1, + "maxLength": 80 + }, + "orderOfDisability": { + "type": "integer", + "description": "The order by severity of individual's disabilities: 1- Primary, 2 - Secondary, 3 - Tertiary, etc." + }, + "disabilityDeterminationSourceTypeDescriptor": { + "type": "string", + "description": "The source that provided the disability determination." + }, + "designations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "disabilityDesignationDescriptor": { + "type": "string", + "description": "An Ed-Fi Descriptor" + } + }, + "additionalProperties": false, + "required": [ + "disabilityDesignationDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "disabilityDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "specialEducationProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialEducationProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the special education program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the student was in this option for the current school year." + }, + "providers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "staffReference": { + "type": "object", + "properties": { + "staffUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a staff.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "staffUniqueId" + ] + }, + "primaryProvider": { + "type": "boolean", + "description": "Primary ServiceProvider." + } + }, + "additionalProperties": false, + "required": [ + "staffReference" + ] + }, + "minItems": 0, + "uniqueItems": false + } + }, + "additionalProperties": false, + "required": [ + "specialEducationProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "IdeaEligibility": [ + "$.ideaEligibility" + ], + "SpecialEducationSetting": [ + "$.specialEducationSettingDescriptor" + ], + "SpecialEducationHoursPerWeek": [ + "$.specialEducationHoursPerWeek" + ], + "SchoolHoursPerWeek": [ + "$.schoolHoursPerWeek" + ], + "MultiplyDisabled": [ + "$.multiplyDisabled" + ], + "MedicallyFragile": [ + "$.medicallyFragile" + ], + "LastEvaluationDate": [ + "$.lastEvaluationDate" + ], + "IEPReviewDate": [ + "$.iepReviewDate" + ], + "IEPBeginDate": [ + "$.iepBeginDate" + ], + "IEPEndDate": [ + "$.iepEndDate" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "studentTitleIPartAProgramAssociations": { + "resourceName": "StudentTitleIPartAProgramAssociation", + "isDescriptor": false, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentTitleIPartAProgramAssociation", + "description": "This association represents the Title I Part A program(s) that a student participates in or from which the student receives services. The association is an extension of the StudentProgramAssociation particular for Title I Part A programs.", + "type": "object", + "properties": { + "titleIPartAParticipantDescriptor": { + "type": "string", + "description": "An indication of the type of Title I program, if any, in which the student is participating and by which the student is served." + }, + "titleIPartAProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "titleIPartAProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Title I Part A Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAParticipantDescriptor", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentTitleIPartAProgramAssociation", + "description": "This association represents the Title I Part A program(s) that a student participates in or from which the student receives services. The association is an extension of the StudentProgramAssociation particular for Title I Part A programs.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "titleIPartAParticipantDescriptor": { + "type": "string", + "description": "An indication of the type of Title I program, if any, in which the student is participating and by which the student is served." + }, + "titleIPartAProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "titleIPartAProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Title I Part A Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [ + "id", + "titleIPartAParticipantDescriptor", + "studentReference", + "programReference", + "beginDate", + "educationOrganizationReference" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Ed-Fi.StudentTitleIPartAProgramAssociation", + "description": "This association represents the Title I Part A program(s) that a student participates in or from which the student receives services. The association is an extension of the StudentProgramAssociation particular for Title I Part A programs.", + "type": "object", + "properties": { + "titleIPartAParticipantDescriptor": { + "type": "string", + "description": "An indication of the type of Title I program, if any, in which the student is participating and by which the student is served." + }, + "titleIPartAProgramServices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "titleIPartAProgramServiceDescriptor": { + "type": "string", + "description": "Indicates the service being provided to the student by the Title I Part A Program." + }, + "primaryIndicator": { + "type": "boolean", + "description": "True if service is a primary service." + }, + "serviceBeginDate": { + "type": "string", + "format": "date", + "description": "First date the Student was in this option for the current school year." + }, + "serviceEndDate": { + "type": "string", + "format": "date", + "description": "Last date the Student was in this option for the current school year." + } + }, + "additionalProperties": false, + "required": [ + "titleIPartAProgramServiceDescriptor" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "studentReference": { + "type": "object", + "properties": { + "studentUniqueId": { + "type": "string", + "description": "A unique alphanumeric code assigned to a student.", + "minLength": 1, + "maxLength": 32 + } + }, + "additionalProperties": false, + "required": [ + "studentUniqueId" + ] + }, + "programReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + }, + "programName": { + "type": "string", + "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", + "minLength": 1, + "maxLength": 60 + }, + "programTypeDescriptor": { + "type": "string", + "description": "The type of program." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ] + }, + "beginDate": { + "type": "string", + "format": "date", + "description": "The earliest date the student is involved with the program. Typically, this is the date the student becomes eligible for the program." + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The month, day, and year on which the student exited the program or stopped receiving services." + }, + "reasonExitedDescriptor": { + "type": "string", + "description": "The reason the student left the program within a school or district." + }, + "educationOrganizationReference": { + "type": "object", + "properties": { + "educationOrganizationId": { + "type": "integer", + "description": "The identifier assigned to an education organization." + } + }, + "additionalProperties": false, + "required": [ + "educationOrganizationId" + ] + }, + "servedOutsideOfRegularSession": { + "type": "boolean", + "description": "Indicates whether the student received services during the summer session or between sessions." + }, + "programParticipationStatuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "participationStatusDescriptor": { + "type": "string", + "description": "The student's program participation status." + }, + "statusBeginDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status began." + }, + "statusEndDate": { + "type": "string", + "format": "date", + "description": "The date the student's program participation status ended." + }, + "designatedBy": { + "type": "string", + "description": "The person, organization, or department that designated the participation status.", + "minLength": 1, + "maxLength": 60 + } + }, + "additionalProperties": false, + "required": [ + "participationStatusDescriptor", + "statusBeginDate" + ] + }, + "minItems": 0, + "uniqueItems": false + }, + "_ext": { + "description": "optional extension collection", + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [ + "BeginDate", + "EducationOrganization", + "Program", + "Student" + ], + "documentPathsMapping": { + "TitleIPartAParticipant": [ + "$.titleIPartAParticipantDescriptor" + ], + "Student": [ + "$.studentReference.studentUniqueId" + ], + "Program": [ + "$.programReference.educationOrganizationId", + "$.programReference.programName", + "$.programReference.programTypeDescriptor" + ], + "BeginDate": [ + "$.beginDate" + ], + "EndDate": [ + "$.endDate" + ], + "ReasonExited": [ + "$.reasonExitedDescriptor" + ], + "EducationOrganization": [ + "$.educationOrganizationReference.educationOrganizationId" + ], + "ServedOutsideOfRegularSession": [ + "$.servedOutsideOfRegularSession" + ] + } + }, + "absenceEventCategoryDescriptors": { + "resourceName": "AbsenceEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "academicHonorCategoryDescriptors": { + "resourceName": "AcademicHonorCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "academicSubjectDescriptors": { + "resourceName": "AcademicSubjectDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "accommodationDescriptors": { + "resourceName": "AccommodationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "accountTypeDescriptors": { + "resourceName": "AccountTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "achievementCategoryDescriptors": { + "resourceName": "AchievementCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "additionalCreditTypeDescriptors": { + "resourceName": "AdditionalCreditTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "addressTypeDescriptors": { + "resourceName": "AddressTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "administrationEnvironmentDescriptors": { + "resourceName": "AdministrationEnvironmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "administrativeFundingControlDescriptors": { + "resourceName": "AdministrativeFundingControlDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "ancestryEthnicOriginDescriptors": { + "resourceName": "AncestryEthnicOriginDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentCategoryDescriptors": { + "resourceName": "AssessmentCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentIdentificationSystemDescriptors": { + "resourceName": "AssessmentIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentItemCategoryDescriptors": { + "resourceName": "AssessmentItemCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentItemResultDescriptors": { + "resourceName": "AssessmentItemResultDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentPeriodDescriptors": { + "resourceName": "AssessmentPeriodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assessmentReportingMethodDescriptors": { + "resourceName": "AssessmentReportingMethodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "assignmentLateStatusDescriptors": { + "resourceName": "AssignmentLateStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "attemptStatusDescriptors": { + "resourceName": "AttemptStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "attendanceEventCategoryDescriptors": { + "resourceName": "AttendanceEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "barrierToInternetAccessInResidenceDescriptors": { + "resourceName": "BarrierToInternetAccessInResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "behaviorDescriptors": { + "resourceName": "BehaviorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "calendarEventDescriptors": { + "resourceName": "CalendarEventDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "calendarTypeDescriptors": { + "resourceName": "CalendarTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "careerPathwayDescriptors": { + "resourceName": "CareerPathwayDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "charterApprovalAgencyTypeDescriptors": { + "resourceName": "CharterApprovalAgencyTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "charterStatusDescriptors": { + "resourceName": "CharterStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "citizenshipStatusDescriptors": { + "resourceName": "CitizenshipStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "classroomPositionDescriptors": { + "resourceName": "ClassroomPositionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cohortScopeDescriptors": { + "resourceName": "CohortScopeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cohortTypeDescriptors": { + "resourceName": "CohortTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cohortYearTypeDescriptors": { + "resourceName": "CohortYearTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "competencyLevelDescriptors": { + "resourceName": "CompetencyLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "contactTypeDescriptors": { + "resourceName": "ContactTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "contentClassDescriptors": { + "resourceName": "ContentClassDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "continuationOfServicesReasonDescriptors": { + "resourceName": "ContinuationOfServicesReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "costRateDescriptors": { + "resourceName": "CostRateDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "countryDescriptors": { + "resourceName": "CountryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseAttemptResultDescriptors": { + "resourceName": "CourseAttemptResultDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseDefinedByDescriptors": { + "resourceName": "CourseDefinedByDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseGPAApplicabilityDescriptors": { + "resourceName": "CourseGPAApplicabilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseIdentificationSystemDescriptors": { + "resourceName": "CourseIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseLevelCharacteristicDescriptors": { + "resourceName": "CourseLevelCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "courseRepeatCodeDescriptors": { + "resourceName": "CourseRepeatCodeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "credentialFieldDescriptors": { + "resourceName": "CredentialFieldDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "credentialTypeDescriptors": { + "resourceName": "CredentialTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "creditCategoryDescriptors": { + "resourceName": "CreditCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "creditTypeDescriptors": { + "resourceName": "CreditTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "cTEProgramServiceDescriptors": { + "resourceName": "CTEProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "curriculumUsedDescriptors": { + "resourceName": "CurriculumUsedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "deliveryMethodDescriptors": { + "resourceName": "DeliveryMethodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "diagnosisDescriptors": { + "resourceName": "DiagnosisDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "diplomaLevelDescriptors": { + "resourceName": "DiplomaLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "diplomaTypeDescriptors": { + "resourceName": "DiplomaTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disabilityDescriptors": { + "resourceName": "DisabilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disabilityDesignationDescriptors": { + "resourceName": "DisabilityDesignationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disabilityDeterminationSourceTypeDescriptors": { + "resourceName": "DisabilityDeterminationSourceTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disciplineDescriptors": { + "resourceName": "DisciplineDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disciplineActionLengthDifferenceReasonDescriptors": { + "resourceName": "DisciplineActionLengthDifferenceReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "disciplineIncidentParticipationCodeDescriptors": { + "resourceName": "DisciplineIncidentParticipationCodeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationalEnvironmentDescriptors": { + "resourceName": "EducationalEnvironmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationOrganizationAssociationTypeDescriptors": { + "resourceName": "EducationOrganizationAssociationTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationOrganizationCategoryDescriptors": { + "resourceName": "EducationOrganizationCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationOrganizationIdentificationSystemDescriptors": { + "resourceName": "EducationOrganizationIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "educationPlanDescriptors": { + "resourceName": "EducationPlanDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "electronicMailTypeDescriptors": { + "resourceName": "ElectronicMailTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "eligibilityDelayReasonDescriptors": { + "resourceName": "EligibilityDelayReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "eligibilityEvaluationTypeDescriptors": { + "resourceName": "EligibilityEvaluationTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "employmentStatusDescriptors": { + "resourceName": "EmploymentStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "enrollmentTypeDescriptors": { + "resourceName": "EnrollmentTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "entryGradeLevelReasonDescriptors": { + "resourceName": "EntryGradeLevelReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "entryTypeDescriptors": { + "resourceName": "EntryTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "evaluationDelayReasonDescriptors": { + "resourceName": "EvaluationDelayReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "eventCircumstanceDescriptors": { + "resourceName": "EventCircumstanceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "exitWithdrawTypeDescriptors": { + "resourceName": "ExitWithdrawTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "financialCollectionDescriptors": { + "resourceName": "FinancialCollectionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradebookEntryTypeDescriptors": { + "resourceName": "GradebookEntryTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradeLevelDescriptors": { + "resourceName": "GradeLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradePointAverageTypeDescriptors": { + "resourceName": "GradePointAverageTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradeTypeDescriptors": { + "resourceName": "GradeTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gradingPeriodDescriptors": { + "resourceName": "GradingPeriodDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "graduationPlanTypeDescriptors": { + "resourceName": "GraduationPlanTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "gunFreeSchoolsActReportingStatusDescriptors": { + "resourceName": "GunFreeSchoolsActReportingStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "homelessPrimaryNighttimeResidenceDescriptors": { + "resourceName": "HomelessPrimaryNighttimeResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "homelessProgramServiceDescriptors": { + "resourceName": "HomelessProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "iDEAPartDescriptors": { + "resourceName": "IDEAPartDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "identificationDocumentUseDescriptors": { + "resourceName": "IdentificationDocumentUseDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "incidentLocationDescriptors": { + "resourceName": "IncidentLocationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "indicatorDescriptors": { + "resourceName": "IndicatorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "indicatorGroupDescriptors": { + "resourceName": "IndicatorGroupDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "indicatorLevelDescriptors": { + "resourceName": "IndicatorLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "institutionTelephoneNumberTypeDescriptors": { + "resourceName": "InstitutionTelephoneNumberTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "interactivityStyleDescriptors": { + "resourceName": "InteractivityStyleDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "internetAccessDescriptors": { + "resourceName": "InternetAccessDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "internetAccessTypeInResidenceDescriptors": { + "resourceName": "InternetAccessTypeInResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "internetPerformanceInResidenceDescriptors": { + "resourceName": "InternetPerformanceInResidenceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "interventionClassDescriptors": { + "resourceName": "InterventionClassDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "interventionEffectivenessRatingDescriptors": { + "resourceName": "InterventionEffectivenessRatingDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "languageDescriptors": { + "resourceName": "LanguageDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "languageInstructionProgramServiceDescriptors": { + "resourceName": "LanguageInstructionProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "languageUseDescriptors": { + "resourceName": "LanguageUseDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "learningStandardCategoryDescriptors": { + "resourceName": "LearningStandardCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "learningStandardEquivalenceStrengthDescriptors": { + "resourceName": "LearningStandardEquivalenceStrengthDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "learningStandardScopeDescriptors": { + "resourceName": "LearningStandardScopeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "levelOfEducationDescriptors": { + "resourceName": "LevelOfEducationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "licenseStatusDescriptors": { + "resourceName": "LicenseStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "licenseTypeDescriptors": { + "resourceName": "LicenseTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "limitedEnglishProficiencyDescriptors": { + "resourceName": "LimitedEnglishProficiencyDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "localeDescriptors": { + "resourceName": "LocaleDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "localEducationAgencyCategoryDescriptors": { + "resourceName": "LocalEducationAgencyCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "magnetSpecialProgramEmphasisSchoolDescriptors": { + "resourceName": "MagnetSpecialProgramEmphasisSchoolDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "mediumOfInstructionDescriptors": { + "resourceName": "MediumOfInstructionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "methodCreditEarnedDescriptors": { + "resourceName": "MethodCreditEarnedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "migrantEducationProgramServiceDescriptors": { + "resourceName": "MigrantEducationProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "modelEntityDescriptors": { + "resourceName": "ModelEntityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "monitoredDescriptors": { + "resourceName": "MonitoredDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "neglectedOrDelinquentProgramDescriptors": { + "resourceName": "NeglectedOrDelinquentProgramDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "neglectedOrDelinquentProgramServiceDescriptors": { + "resourceName": "NeglectedOrDelinquentProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "networkPurposeDescriptors": { + "resourceName": "NetworkPurposeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "operationalStatusDescriptors": { + "resourceName": "OperationalStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "otherNameTypeDescriptors": { + "resourceName": "OtherNameTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "participationDescriptors": { + "resourceName": "ParticipationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "participationStatusDescriptors": { + "resourceName": "ParticipationStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "performanceBaseConversionDescriptors": { + "resourceName": "PerformanceBaseConversionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "performanceLevelDescriptors": { + "resourceName": "PerformanceLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "personalInformationVerificationDescriptors": { + "resourceName": "PersonalInformationVerificationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "platformTypeDescriptors": { + "resourceName": "PlatformTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "populationServedDescriptors": { + "resourceName": "PopulationServedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "postingResultDescriptors": { + "resourceName": "PostingResultDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "postSecondaryEventCategoryDescriptors": { + "resourceName": "PostSecondaryEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "postSecondaryInstitutionLevelDescriptors": { + "resourceName": "PostSecondaryInstitutionLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "primaryLearningDeviceAccessDescriptors": { + "resourceName": "PrimaryLearningDeviceAccessDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "primaryLearningDeviceAwayFromSchoolDescriptors": { + "resourceName": "PrimaryLearningDeviceAwayFromSchoolDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "primaryLearningDeviceProviderDescriptors": { + "resourceName": "PrimaryLearningDeviceProviderDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "proficiencyDescriptors": { + "resourceName": "ProficiencyDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programAssignmentDescriptors": { + "resourceName": "ProgramAssignmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programCharacteristicDescriptors": { + "resourceName": "ProgramCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programSponsorDescriptors": { + "resourceName": "ProgramSponsorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "programTypeDescriptors": { + "resourceName": "ProgramTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "progressDescriptors": { + "resourceName": "ProgressDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "progressLevelDescriptors": { + "resourceName": "ProgressLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "providerCategoryDescriptors": { + "resourceName": "ProviderCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "providerProfitabilityDescriptors": { + "resourceName": "ProviderProfitabilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "providerStatusDescriptors": { + "resourceName": "ProviderStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "publicationStatusDescriptors": { + "resourceName": "PublicationStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "questionFormDescriptors": { + "resourceName": "QuestionFormDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "raceDescriptors": { + "resourceName": "RaceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "reasonExitedDescriptors": { + "resourceName": "ReasonExitedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "reasonNotTestedDescriptors": { + "resourceName": "ReasonNotTestedDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "recognitionTypeDescriptors": { + "resourceName": "RecognitionTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "relationDescriptors": { + "resourceName": "RelationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "repeatIdentifierDescriptors": { + "resourceName": "RepeatIdentifierDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "reporterDescriptionDescriptors": { + "resourceName": "ReporterDescriptionDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "reportingTagDescriptors": { + "resourceName": "ReportingTagDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "residencyStatusDescriptors": { + "resourceName": "ResidencyStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "responseIndicatorDescriptors": { + "resourceName": "ResponseIndicatorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "responsibilityDescriptors": { + "resourceName": "ResponsibilityDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "restraintEventReasonDescriptors": { + "resourceName": "RestraintEventReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "resultDatatypeTypeDescriptors": { + "resourceName": "ResultDatatypeTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "retestIndicatorDescriptors": { + "resourceName": "RetestIndicatorDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolCategoryDescriptors": { + "resourceName": "SchoolCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolChoiceBasisDescriptors": { + "resourceName": "SchoolChoiceBasisDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolChoiceImplementStatusDescriptors": { + "resourceName": "SchoolChoiceImplementStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolFoodServiceProgramServiceDescriptors": { + "resourceName": "SchoolFoodServiceProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "schoolTypeDescriptors": { + "resourceName": "SchoolTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "sectionCharacteristicDescriptors": { + "resourceName": "SectionCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "separationDescriptors": { + "resourceName": "SeparationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "separationReasonDescriptors": { + "resourceName": "SeparationReasonDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "serviceDescriptors": { + "resourceName": "ServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "sexDescriptors": { + "resourceName": "SexDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "sourceSystemDescriptors": { + "resourceName": "SourceSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "specialEducationProgramServiceDescriptors": { + "resourceName": "SpecialEducationProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "specialEducationSettingDescriptors": { + "resourceName": "SpecialEducationSettingDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "staffClassificationDescriptors": { + "resourceName": "StaffClassificationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "staffIdentificationSystemDescriptors": { + "resourceName": "StaffIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "staffLeaveEventCategoryDescriptors": { + "resourceName": "StaffLeaveEventCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "stateAbbreviationDescriptors": { + "resourceName": "StateAbbreviationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "studentCharacteristicDescriptors": { + "resourceName": "StudentCharacteristicDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "studentIdentificationSystemDescriptors": { + "resourceName": "StudentIdentificationSystemDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "studentParticipationCodeDescriptors": { + "resourceName": "StudentParticipationCodeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "submissionStatusDescriptors": { + "resourceName": "SubmissionStatusDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "surveyCategoryDescriptors": { + "resourceName": "SurveyCategoryDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "surveyLevelDescriptors": { + "resourceName": "SurveyLevelDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "teachingCredentialDescriptors": { + "resourceName": "TeachingCredentialDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "teachingCredentialBasisDescriptors": { + "resourceName": "TeachingCredentialBasisDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "technicalSkillsAssessmentDescriptors": { + "resourceName": "TechnicalSkillsAssessmentDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "telephoneNumberTypeDescriptors": { + "resourceName": "TelephoneNumberTypeDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "termDescriptors": { + "resourceName": "TermDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "titleIPartAParticipantDescriptors": { + "resourceName": "TitleIPartAParticipantDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "titleIPartAProgramServiceDescriptors": { + "resourceName": "TitleIPartAProgramServiceDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "titleIPartASchoolDesignationDescriptors": { + "resourceName": "TitleIPartASchoolDesignationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "tribalAffiliationDescriptors": { + "resourceName": "TribalAffiliationDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "visaDescriptors": { + "resourceName": "VisaDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + }, + "weaponDescriptors": { + "resourceName": "WeaponDescriptor", + "isDescriptor": true, + "allowIdentityUpdates": false, + "jsonSchemaForInsert": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForUpdate": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The item id" + }, + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [ + "id", + "namespace", + "codeValue", + "shortDescription" + ] + }, + "jsonSchemaForQuery": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "EdFi.Descriptor", + "description": "An Ed-Fi Descriptor", + "type": "object", + "properties": { + "namespace": { + "type": "string", + "description": "The descriptor namespace as a URI" + }, + "codeValue": { + "type": "string", + "description": "The descriptor code value" + }, + "shortDescription": { + "type": "string", + "description": "The descriptor short description" + }, + "description": { + "type": "string", + "description": "The descriptor description" + } + }, + "additionalProperties": false, + "required": [] + }, + "equalityConstraints": [], + "identityFullnames": [] + } + } + } + } +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts b/Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts index a50b8e90..90e76e11 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts @@ -5,15 +5,6 @@ import R from 'ramda'; import { invariant } from 'ts-invariant'; -import { EntityProperty, TopLevelEntity } from '@edfi/metaed-core'; -import { - topLevelApiNameOnEntity, - ReferenceComponent, - isReferenceElement, - EntityApiSchemaData, - EntityPropertyApiSchemaData, -} from '@edfi/metaed-plugin-edfi-api-schema'; -import { decapitalize } from '../Utility'; import { SuperclassInfo } from '../model/SuperclassInfo'; import { DocumentIdentity } from '../model/DocumentIdentity'; import { DescriptorDocument } from '../model/DescriptorDocument'; @@ -21,89 +12,6 @@ import { descriptorDocumentIdentityFrom } from '../model/DescriptorDocumentInfo' import { SchoolYearEnumerationDocument } from '../model/SchoolYearEnumerationDocument'; import { schoolYearEnumerationDocumentIdentityFrom } from '../model/SchoolYearEnumerationDocumentInfo'; -type NullableTopLevelEntity = { superclass: TopLevelEntity | null }; - -/** - * Takes a non-reference property representing a portion of the identity of a MetaEd entity, - * an API JSON body matching that entity, and a path to the location of the property value - * in the JSON body, and returns that portion of the document identity extracted from the JSON body. - * - * documentPath is a path in the JSON body as a string array with one path segment per array element. - */ -function singleIdentityFrom(property: EntityProperty, body: object, documentPath: string[]): DocumentIdentity { - const { apiMapping } = property.data.edfiApiSchema as EntityPropertyApiSchemaData; - - let path: string[]; - - if (property.type === 'schoolYearEnumeration' && property.roleName !== '') { - path = [...documentPath, 'schoolYear']; - } else { - path = [...documentPath, apiMapping.fullName]; - } - - const documentPathAsString: string = path.join('.'); - - const elementValue: string | undefined = R.path(path, body); - - invariant( - elementValue != null, - `Identity element value for ${property.metaEdName} not found in ${JSON.stringify(body)} at ${documentPathAsString}`, - ); - - return { [documentPathAsString]: elementValue }; -} - -/** - * Takes a ReferenceComponent representing an identity of a MetaEd entity along with - * an API JSON body matching that entity and returns the document identity extracted - * from the JSON body. - * - * documentPath is an accumulator allowing this function to recursively build up paths in the - * JSON body as a string array with one path segment per array element. This allows use - * of the path() function of the ramdajs library (https://ramdajs.com/docs/#path) to extract - * values from the JSON body. - */ -function documentIdentitiesFrom( - identityReferenceComponent: ReferenceComponent, - body: object, - entity: TopLevelEntity, - documentPath: string[], -): DocumentIdentity[] { - if (isReferenceElement(identityReferenceComponent)) { - // SchoolYearEnumerations are an API one-off expressed as two levels in the document body - if (identityReferenceComponent.sourceProperty.type === 'schoolYearEnumeration') { - const { roleName } = identityReferenceComponent.sourceProperty; - if (roleName !== '') { - documentPath.push(`${decapitalize(roleName)}SchoolYearTypeReference`); - } else { - documentPath.push('schoolYearTypeReference'); - } - } - return [singleIdentityFrom(identityReferenceComponent.sourceProperty, body, documentPath)]; - } - - const result: DocumentIdentity[] = []; - identityReferenceComponent.referenceComponents.forEach((childComponent: ReferenceComponent) => { - const identityTopLevelName = topLevelApiNameOnEntity(entity, identityReferenceComponent.sourceProperty); - const newDocumentPath: string[] = documentPath.length > 0 ? documentPath : [identityTopLevelName]; - if (isReferenceElement(childComponent)) { - result.push(singleIdentityFrom(childComponent.sourceProperty, body, newDocumentPath)); - } else { - result.push(...documentIdentitiesFrom(childComponent, body, entity, newDocumentPath)); - } - }); - return result; -} - -/** - * Collapses an array of DocumentIdentity objects into a single DocumentIdentity. - */ -function documentIdentityFrom(documentIdentities: DocumentIdentity[]): DocumentIdentity { - return documentIdentities.reduce( - (accumulator: DocumentIdentity, current: DocumentIdentity) => ({ ...accumulator, ...current }), - {}, - ); -} /** * Takes a MetaEd entity object and a API JSON body for the resource mapped to that MetaEd entity and diff --git a/Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts.old b/Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts.old new file mode 100644 index 00000000..a50b8e90 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/extraction/DocumentIdentityExtractor.ts.old @@ -0,0 +1,166 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import R from 'ramda'; +import { invariant } from 'ts-invariant'; +import { EntityProperty, TopLevelEntity } from '@edfi/metaed-core'; +import { + topLevelApiNameOnEntity, + ReferenceComponent, + isReferenceElement, + EntityApiSchemaData, + EntityPropertyApiSchemaData, +} from '@edfi/metaed-plugin-edfi-api-schema'; +import { decapitalize } from '../Utility'; +import { SuperclassInfo } from '../model/SuperclassInfo'; +import { DocumentIdentity } from '../model/DocumentIdentity'; +import { DescriptorDocument } from '../model/DescriptorDocument'; +import { descriptorDocumentIdentityFrom } from '../model/DescriptorDocumentInfo'; +import { SchoolYearEnumerationDocument } from '../model/SchoolYearEnumerationDocument'; +import { schoolYearEnumerationDocumentIdentityFrom } from '../model/SchoolYearEnumerationDocumentInfo'; + +type NullableTopLevelEntity = { superclass: TopLevelEntity | null }; + +/** + * Takes a non-reference property representing a portion of the identity of a MetaEd entity, + * an API JSON body matching that entity, and a path to the location of the property value + * in the JSON body, and returns that portion of the document identity extracted from the JSON body. + * + * documentPath is a path in the JSON body as a string array with one path segment per array element. + */ +function singleIdentityFrom(property: EntityProperty, body: object, documentPath: string[]): DocumentIdentity { + const { apiMapping } = property.data.edfiApiSchema as EntityPropertyApiSchemaData; + + let path: string[]; + + if (property.type === 'schoolYearEnumeration' && property.roleName !== '') { + path = [...documentPath, 'schoolYear']; + } else { + path = [...documentPath, apiMapping.fullName]; + } + + const documentPathAsString: string = path.join('.'); + + const elementValue: string | undefined = R.path(path, body); + + invariant( + elementValue != null, + `Identity element value for ${property.metaEdName} not found in ${JSON.stringify(body)} at ${documentPathAsString}`, + ); + + return { [documentPathAsString]: elementValue }; +} + +/** + * Takes a ReferenceComponent representing an identity of a MetaEd entity along with + * an API JSON body matching that entity and returns the document identity extracted + * from the JSON body. + * + * documentPath is an accumulator allowing this function to recursively build up paths in the + * JSON body as a string array with one path segment per array element. This allows use + * of the path() function of the ramdajs library (https://ramdajs.com/docs/#path) to extract + * values from the JSON body. + */ +function documentIdentitiesFrom( + identityReferenceComponent: ReferenceComponent, + body: object, + entity: TopLevelEntity, + documentPath: string[], +): DocumentIdentity[] { + if (isReferenceElement(identityReferenceComponent)) { + // SchoolYearEnumerations are an API one-off expressed as two levels in the document body + if (identityReferenceComponent.sourceProperty.type === 'schoolYearEnumeration') { + const { roleName } = identityReferenceComponent.sourceProperty; + if (roleName !== '') { + documentPath.push(`${decapitalize(roleName)}SchoolYearTypeReference`); + } else { + documentPath.push('schoolYearTypeReference'); + } + } + return [singleIdentityFrom(identityReferenceComponent.sourceProperty, body, documentPath)]; + } + + const result: DocumentIdentity[] = []; + identityReferenceComponent.referenceComponents.forEach((childComponent: ReferenceComponent) => { + const identityTopLevelName = topLevelApiNameOnEntity(entity, identityReferenceComponent.sourceProperty); + const newDocumentPath: string[] = documentPath.length > 0 ? documentPath : [identityTopLevelName]; + if (isReferenceElement(childComponent)) { + result.push(singleIdentityFrom(childComponent.sourceProperty, body, newDocumentPath)); + } else { + result.push(...documentIdentitiesFrom(childComponent, body, entity, newDocumentPath)); + } + }); + return result; +} + +/** + * Collapses an array of DocumentIdentity objects into a single DocumentIdentity. + */ +function documentIdentityFrom(documentIdentities: DocumentIdentity[]): DocumentIdentity { + return documentIdentities.reduce( + (accumulator: DocumentIdentity, current: DocumentIdentity) => ({ ...accumulator, ...current }), + {}, + ); +} + +/** + * Takes a MetaEd entity object and a API JSON body for the resource mapped to that MetaEd entity and + * extracts the document identity information from the JSON body. Also extracts security information, if any. + */ +export function extractDocumentIdentity(entity: TopLevelEntity, body: object): DocumentIdentity { + if (entity.type === 'descriptor') return descriptorDocumentIdentityFrom(body as DescriptorDocument); + if (entity.type === 'schoolYearEnumeration') + return schoolYearEnumerationDocumentIdentityFrom(body as SchoolYearEnumerationDocument); + + // identityReferenceComponents can represent a tree of identity information, thus the need to + // flatmap into identities per top level component. + const documentIdentities: DocumentIdentity[] = ( + entity.data.edfiApiSchema as EntityApiSchemaData + ).apiMapping.identityReferenceComponents.flatMap((identityReferenceComponent: ReferenceComponent) => + documentIdentitiesFrom(identityReferenceComponent, body, entity, []), + ); + + // Combine the individual document identities from the top level components into a single one + return documentIdentityFrom(documentIdentities); +} + +/** + * Create a SuperclassInfo from an already constructed DocumentIdentity, if the entity should have one. + * If the entity is a subclass with an identity rename, replace the renamed identity property with the + * original superclass identity property name, thereby putting it in superclass form. + * + * For example, School is a subclass of EducationOrganization which renames educationOrganizationId + * to schoolId. An example document identity for a School is { name: schoolId, value: 123 }. The + * equivalent superclass identity for this School would be { name: educationOrganizationId, value: 123 }. + * + */ +export function deriveSuperclassInfoFrom(entity: TopLevelEntity, documentIdentity: DocumentIdentity): SuperclassInfo | null { + const { superclass }: NullableTopLevelEntity = (entity.data.edfiApiSchema as EntityApiSchemaData).apiMapping; + if (superclass == null) return null; + const identityRename: EntityProperty | undefined = entity.identityProperties.find((p) => p.isIdentityRename); + if (identityRename == null) { + return { resourceName: superclass.metaEdName, documentIdentity, projectName: superclass.namespace.projectName }; + } + + const subclassName = decapitalize(identityRename.metaEdName); + const superclassName = decapitalize(identityRename.baseKeyName); + + if (documentIdentity[subclassName] == null) { + return { resourceName: superclass.metaEdName, documentIdentity, projectName: superclass.namespace.projectName }; + } + + // copy the DocumentIdentity so the original is not affected + const superclassIdentity: DocumentIdentity = { ...documentIdentity }; + + // Replace subclassName with superclassName + delete superclassIdentity[subclassName]; + superclassIdentity[superclassName] = documentIdentity[subclassName]; + + return { + resourceName: superclass.metaEdName, + projectName: superclass.namespace.projectName, + documentIdentity: superclassIdentity, + }; +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/handler/Delete.ts b/Meadowlark-js/packages/meadowlark-core/src/handler/Delete.ts index d83739b3..3ae267cc 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/handler/Delete.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/handler/Delete.ts @@ -3,7 +3,6 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import R from 'ramda'; import { isDebugEnabled, writeErrorToLog } from '@edfi/meadowlark-utilities'; import { writeDebugStatusToLog, writeRequestToLog } from '../Logger'; import { getDocumentStore } from '../plugin/PluginLoader'; @@ -29,7 +28,7 @@ export async function deleteIt(frontendRequest: FrontendRequest): Promise FrontendRequest = R.dissocPath([ - 'middleware', - 'matchingMetaEdModel', -]); +const removeJsonSchemas: (f: FrontendRequest) => FrontendRequest = R.pipe( + R.dissocPath(['middleware', 'resourceSchema', 'jsonSchemaForInsert']), + R.dissocPath(['middleware', 'resourceSchema', 'jsonSchemaForQuery']), + R.dissocPath(['middleware', 'resourceSchema', 'jsonSchemaForUpdate']), +); /** * Returns a copy of a FrontendRequest with the sensitive data 'body' field removed @@ -154,7 +174,7 @@ export const removeReferencesDocumentIdentity: (f: FrontendRequest) => FrontendR * Returns a copy of a FrontendRequest suitable for logging, such as with non-serializable fields or sensitive data removed */ export const frontendRequestForLogging: (f: FrontendRequest) => FrontendRequest = R.pipe( - removeMatchingMetaEdModel, + removeJsonSchemas, removeBody, removeParsedBody, removeDocumentIdentity, diff --git a/Meadowlark-js/packages/meadowlark-core/src/handler/GetById.ts b/Meadowlark-js/packages/meadowlark-core/src/handler/GetById.ts index 074250d9..609a4b59 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/handler/GetById.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/handler/GetById.ts @@ -20,7 +20,7 @@ const moduleName = 'core.handler.GetById'; */ export async function getById(frontendRequest: FrontendRequest): Promise { if (frontendRequest.middleware.pathComponents.documentUuid == null) { - writeDebugStatusToLog(moduleName, frontendRequest, 'getById', 404); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'getById', 404); return { statusCode: 404 }; } const request: GetRequest = { @@ -37,12 +37,12 @@ export async function getById(frontendRequest: FrontendRequest): Promise { writeDebugStatusToLog( moduleName, - frontendRequest, + frontendRequest.traceId, 'query', undefined, `query string: ${JSON.stringify(frontendRequest.queryParameters)}`, @@ -37,7 +37,7 @@ export async function query(frontendRequest: FrontendRequest): Promise { let uri = resourceUriFrom( { - version: versionAbbreviationFor(document.resourceVersion), - namespace: document.projectName.toLowerCase(), // Lower casing is correct for Ed-Fi models, not sure about alternatives - resourceName: uncapitalize(pluralize(document.resourceName)), + projectShortVersion: versionAbbreviationFor(document.resourceVersion), + projectNamespace: document.projectName.toLowerCase() as ProjectNamespace, // Lower casing is correct for Ed-Fi models, not sure about alternatives + endpointName: uncapitalize(pluralize(document.resourceName)) as EndpointName, }, document.documentUuid, ); diff --git a/Meadowlark-js/packages/meadowlark-core/src/index.ts b/Meadowlark-js/packages/meadowlark-core/src/index.ts index a809621f..22bb67d9 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/index.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/index.ts @@ -28,10 +28,7 @@ export { AuthorizationStrategy } from './security/AuthorizationStrategy'; export type { DocumentReference } from './model/DocumentReference'; export type { DocumentIdentity } from './model/DocumentIdentity'; export type { MissingIdentity } from './model/DocumentIdentity'; -export type { FrontendRequest, Headers } from './handler/FrontendRequest'; -export { newFrontendRequest, newFrontendRequestMiddleware } from './handler/FrontendRequest'; -export type { FrontendResponse } from './handler/FrontendResponse'; -export { newFrontendResponse, newFrontendResponseSuccess } from './handler/FrontendResponse'; +export { newPathComponents } from './model/PathComponents'; export { meadowlarkIdForDocumentIdentity, generateDocumentUuid, NoDocumentIdentity } from './model/DocumentIdentity'; export { getMeadowlarkIdForDocumentReference } from './model/DocumentReference'; export type { DocumentInfo } from './model/DocumentInfo'; @@ -57,3 +54,7 @@ export { dependencies, xsdMetadata, } from './handler/MetadataHandler'; +export type { FrontendRequest, Headers } from './handler/FrontendRequest'; +export { newFrontendRequest, newFrontendRequestMiddleware } from './handler/FrontendRequest'; +export type { FrontendResponse } from './handler/FrontendResponse'; +export { newFrontendResponse, newFrontendResponseSuccess } from './handler/FrontendResponse'; diff --git a/Meadowlark-js/packages/meadowlark-core/src/metaed/LoadMetaEd.ts b/Meadowlark-js/packages/meadowlark-core/src/metaed/LoadMetaEd.ts deleted file mode 100644 index 38a13b86..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/metaed/LoadMetaEd.ts +++ /dev/null @@ -1,101 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import path from 'path'; -import fs from 'fs-extra'; -import { - executePipeline, - newMetaEdConfiguration, - newPipelineOptions, - newState, - State, - MetaEdConfiguration, -} from '@edfi/metaed-core'; -import { initialize as edfiApiSchema } from '@edfi/metaed-plugin-edfi-api-schema'; -import { initialize as edfiUnified } from '@edfi/metaed-plugin-edfi-unified'; - -import { findMetaEdProjectMetadata, MetaEdProjectMetadata } from './MetaEdProjectMetadata'; - -/** - * Determine whether we are in a deployed Lambda environment or in a development monorepo environment, - * where a 'packages' directory exists. - */ -const isDevEnvironment = () => fs.existsSync(path.resolve(__dirname, '../../../../packages')); - -/** - * Get the correct node_modules path, whether we are in a deployed Lambda environment - * or in a development monorepo environment - */ - -function nodeModulesPath(): string { - const directory = isDevEnvironment() ? '../../../../node_modules' : '../../node_modules'; - return path.resolve(__dirname, directory); -} - -/** - * Creates a MetaEdConfiguration object from MetaEdProjectMetadata - */ -function metaEdConfigurationFrom(metaEdProjectMetadata: MetaEdProjectMetadata[]): MetaEdConfiguration { - const metaEdConfiguration: MetaEdConfiguration = { - ...newMetaEdConfiguration(), - defaultPluginTechVersion: '3.4.0', - }; - - metaEdProjectMetadata.forEach((pm) => { - metaEdConfiguration.projects.push({ - namespaceName: pm.projectNamespace, - projectName: pm.projectName, - projectVersion: pm.projectVersion, - projectExtension: pm.projectExtension, - description: '', - }); - metaEdConfiguration.projectPaths.push(pm.projectPath); - }); - - return metaEdConfiguration; -} - -// TODO in RND-260: should probably include project version in key -/** - * This is a simple cache implementation that works in Lambdas, see: https://rewind.io/blog/simple-caching-in-aws-lambda-functions/ - */ -const stateCache = {}; - -function setStateCache(packageName: string, state: State) { - stateCache[packageName] = state; -} - -function getStateCache(packageName: string): State | undefined { - return stateCache[packageName]; -} - -/** - * Entry point for loading a MetaEd project, building a MetaEd internal model and running enhancers. - */ -export async function loadMetaEdState(projectNpmPackageName: string): Promise { - const cachedState: State | undefined = getStateCache(projectNpmPackageName); - if (cachedState != null) return cachedState; - - const nodeModules = nodeModulesPath(); - const projectPath = path.resolve(nodeModules, projectNpmPackageName); - const metaEdProjectMetadata: MetaEdProjectMetadata[] = await findMetaEdProjectMetadata([projectPath]); - const metaEdConfiguration = metaEdConfigurationFrom(metaEdProjectMetadata); - - let state: State = { - ...newState(), - metaEdConfiguration, - pipelineOptions: Object.assign(newPipelineOptions(), { - runValidators: true, - runEnhancers: true, - }), - metaEdPlugins: [edfiUnified(), edfiApiSchema()], - }; - - // run MetaEd with downloaded packages - state = (await executePipeline(state)).state; - - setStateCache(projectNpmPackageName, state); - return state; -} diff --git a/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdModelFinder.ts b/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdModelFinder.ts deleted file mode 100644 index 8cd5e310..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdModelFinder.ts +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import { TopLevelEntity } from '@edfi/metaed-core'; -import { PathComponents } from '../model/PathComponents'; -import { decapitalize } from '../Utility'; -import { loadMetaEdState } from './LoadMetaEd'; -import { modelPackageFor } from './MetaEdProjectMetadata'; -import { getMetaEdModelForResourceName } from './ResourceNameMapping'; - -/** - * Finds the MetaEd internal model that represents the given REST resource path. - */ -export async function findMetaEdModel(pathComponents: PathComponents): Promise { - const lowerResourceName = decapitalize(pathComponents.resourceName); - const modelNpmPackage = modelPackageFor(pathComponents.version); - const { metaEd } = await loadMetaEdState(modelNpmPackage); - - return getMetaEdModelForResourceName(lowerResourceName, metaEd, pathComponents.namespace); -} diff --git a/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdProjectMetadata.ts b/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdProjectMetadata.ts deleted file mode 100644 index c2522dc7..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdProjectMetadata.ts +++ /dev/null @@ -1,138 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import fs from 'fs-extra'; -import path from 'path'; -import semver from 'semver'; -import { deriveNamespaceFromProjectName } from '@edfi/metaed-core'; -import { Constants } from '../Constants'; - -const PROJECT_SETTINGS_FILE_NAME = 'package.json'; - -/** - * The metadata information from a MetaEd project's package.json - */ -interface ProjectFileData { - projectName: string; - projectVersion: string; -} - -/** - * A full set of metadata information for a MetaEd project, including whether the project - * itself is valid. - */ -export interface MetaEdProjectMetadata { - projectPath: string; - invalidProject: boolean; - invalidProjectReason: string; - projectName: string; - projectVersion: string; - projectNamespace: string; - isExtensionProject: boolean; - projectExtension: string; -} - -/** - * A hardcoded mapping of URI version abbreviations to Ed-Fi Model npm package names - */ -export function modelPackageFor(versionAbbreviation: string): string { - if (versionAbbreviation === Constants.uriVersion31) return '@edfi/ed-fi-model-3.1'; - if (versionAbbreviation === Constants.uriVersion33b) return '@edfi/ed-fi-model-3.3b'; - return 'ed-fi-model-undefined'; -} - -/** - * A hardcoded mapping of Ed-Fi Model project versions to URI abbreviations - */ -export function versionAbbreviationFor(projectVersion: string): string { - if (projectVersion === Constants.projectVersion31) return Constants.uriVersion31; - if (projectVersion === Constants.projectVersion33b) return Constants.uriVersion33b; - return 'v0.0'; -} - -/** - * Default initialization of a MetaEdProjectMetadata object - */ -function newMetaEdProjectMetadata(projectPath: string): MetaEdProjectMetadata { - return { - projectPath, - invalidProject: false, - invalidProjectReason: '', - projectName: '', - projectVersion: '', - projectNamespace: '', - isExtensionProject: false, - projectExtension: '', - }; -} - -/** - * Read the package.json file for a MetaEd project and extract the project name and version. - */ -async function projectValuesFromProjectJson(verifiedPathToProjectJson: string): Promise { - const projectJson = await fs.readJson(verifiedPathToProjectJson); - if (projectJson.metaEdProject && projectJson.metaEdProject.projectName && projectJson.metaEdProject.projectVersion) - return projectJson.metaEdProject; - return null; -} - -/** - * Entry point for finding and validating MetaEd projects given file system paths. - * - * Similar to the behavior of the atom-metaed package for the Atom editor. - */ -export async function findMetaEdProjectMetadata(projectPaths: string[]): Promise { - const result: MetaEdProjectMetadata[] = await Promise.all( - projectPaths.map(async (projectPath: string) => { - const projectJsonFilePath = path.join(projectPath, PROJECT_SETTINGS_FILE_NAME); - if (!fs.existsSync(projectJsonFilePath)) { - return { - ...newMetaEdProjectMetadata(projectPath), - invalidProject: true, - invalidProjectReason: `does not exist at ${projectPath}`, - }; - } - - const projectFileData: ProjectFileData | null = await projectValuesFromProjectJson(projectJsonFilePath); - if (projectFileData == null) { - return { - ...newMetaEdProjectMetadata(projectPath), - invalidProject: true, - invalidProjectReason: 'must have both metaEdProject.projectName and metaEdProject.projectVersion definitions', - }; - } - - const projectNamespace: string | null = deriveNamespaceFromProjectName(projectFileData.projectName); - if (projectNamespace == null) { - return { - ...newMetaEdProjectMetadata(projectPath), - invalidProject: true, - invalidProjectReason: - 'metaEdProject.projectName definition must begin with an uppercase character. All other characters must be alphanumeric only.', - }; - } - - const projectVersion = projectFileData.projectVersion || ''; - if (!semver.valid(projectVersion)) { - return { - ...newMetaEdProjectMetadata(projectPath), - invalidProject: true, - invalidProjectReason: - 'metaEdProject.projectVersion is not a valid version declaration. Version declarations must follow the semver.org standard.', - }; - } - - return { - ...newMetaEdProjectMetadata(projectPath), - projectName: projectFileData.projectName, - projectVersion, - projectNamespace, - isExtensionProject: projectNamespace !== 'EdFi', - projectExtension: projectNamespace === 'EdFi' ? '' : 'EXTENSION', - }; - }), - ); - return result; -} diff --git a/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdValidation.ts b/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdValidation.ts deleted file mode 100644 index 2eea1b04..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/metaed/MetaEdValidation.ts +++ /dev/null @@ -1,179 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import Ajv from 'ajv/dist/2020'; -import addFormatsTo from 'ajv-formats'; -import type { ErrorObject, ValidateFunction } from 'ajv'; -import { betterAjvErrors, ValidationError } from '@apideck/better-ajv-errors'; -import didYouMean from 'didyoumean2'; -import { MetaEdEnvironment, TopLevelEntity, NoTopLevelEntity } from '@edfi/metaed-core'; -import { getBooleanFromEnvironment } from '@edfi/meadowlark-utilities'; -import type { ResourceMatchResult } from '../model/ResourceMatchResult'; -import { getMetaEdModelForResourceName, getResourceNamesForProject } from './ResourceNameMapping'; -import type { FrontendQueryParameters } from '../handler/FrontendRequest'; - -/** - * Compiled ajv JSON Schema validator functions for the API resource - */ -export type ResourceSchemaValidators = { - insertValidator: ValidateFunction; - updateValidator: ValidateFunction; - queryValidator: ValidateFunction; -}; - -function initializeAjv(): Ajv { - const coerceTypes = getBooleanFromEnvironment('ALLOW_TYPE_COERCION', false); - - const ajv = new Ajv({ allErrors: true, coerceTypes }); - addFormatsTo(ajv); - - return ajv; -} - -const ajv = initializeAjv(); - -// simple cache implementation, see: https://rewind.io/blog/simple-caching-in-aws-lambda-functions/ -/** This is a cache mapping MetaEd model objects to compiled ajv JSON Schema validators for the API resource */ -const validatorCache: Map = new Map(); - -/** - * Returns the API resource JSON Schema validator functions for the given MetaEd model. Caches results. - */ -function getSchemaValidatorsFor(metaEdModel: TopLevelEntity): ResourceSchemaValidators { - const cachedValidators: ResourceSchemaValidators | undefined = validatorCache.get(metaEdModel); - if (cachedValidators != null) return cachedValidators; - - const resourceValidators: ResourceSchemaValidators = { - insertValidator: ajv.compile(metaEdModel.data.edfiApiSchema.jsonSchemaForInsert), - updateValidator: ajv.compile(metaEdModel.data.edfiApiSchema.jsonSchemaForUpdate), - queryValidator: ajv.compile({ - ...metaEdModel.data.edfiApiSchema.jsonSchemaForInsert, - // Need to relax the validation such that no fields are "required" - required: [], - }), - }; - validatorCache.set(metaEdModel, resourceValidators); - return resourceValidators; -} - -/** - * Creates a new empty ResourceMatchResult object - */ -export function newResourceMatchResult(): ResourceMatchResult { - return { - resourceName: '', - isDescriptor: false, - exact: false, - suggestion: false, - matchingMetaEdModel: NoTopLevelEntity, - }; -} - -/** - * Finds the MetaEd entity name that matches the endpoint of the API request, or provides a suggestion - * if no match is found. - */ -export function matchResourceNameToMetaEd( - resourceName: string, - metaEd: MetaEdEnvironment, - namespace: string, -): ResourceMatchResult { - const matchingMetaEdModel: TopLevelEntity | undefined = getMetaEdModelForResourceName(resourceName, metaEd, namespace); - if (matchingMetaEdModel != null) { - return { - ...newResourceMatchResult(), - resourceName, - isDescriptor: matchingMetaEdModel.type === 'descriptor', - exact: true, - matchingMetaEdModel, - }; - } - - const suggestion = didYouMean(resourceName, getResourceNamesForProject(metaEd, namespace)); - if (suggestion == null) return newResourceMatchResult(); - - const suggestedName = Array.isArray(suggestion) ? suggestion[0] : suggestion; - return { ...newResourceMatchResult(), resourceName: suggestedName, suggestion: true }; -} - -/** - * Validate the JSON body of the request against the Joi schema for the MetaEd entity corresponding - * to the API endpoint. - */ -export function validateEntityBodyAgainstSchema( - metaEdModel: TopLevelEntity, - body: object, - isUpdate: boolean = false, -): ValidationError[] | null { - const resourceValidators: ResourceSchemaValidators = getSchemaValidatorsFor(metaEdModel); - const validator: ValidateFunction = isUpdate ? resourceValidators.updateValidator : resourceValidators.insertValidator; - - const isValid: boolean = validator(body); - - if (isValid) return null; - - return betterAjvErrors({ - data: body, - schema: isUpdate - ? metaEdModel.data.edfiApiSchema.jsonSchemaForUpdate - : metaEdModel.data.edfiApiSchema.jsonSchemaForInsert, - errors: validator.errors, - basePath: '{requestBody}', - }); -} - -/** - * Validates that those queryParameters which are present actually belong in the MetaEd entity. - */ -export function validateQueryParametersAgainstSchema( - metaEdModel: TopLevelEntity, - queryParameters: FrontendQueryParameters, -): string[] { - const { queryValidator } = getSchemaValidatorsFor(metaEdModel); - - let errors: string[] = []; - - /** - * Number and boolean are come through as strings, which causes ajv to fail validation of parameters - * This loops through all query parameters and checks the type against the schema, if the type is numeric or boolean - * it will attempt convert the value. If the conversion is good, we set the value back and ajv will validate the schema - * If the value can't be converted (i.e. a word is provided for a numeric value, we leave it and let ajv invalidate - * the schema). - */ - Object.keys(queryParameters).forEach((keyValue) => { - const property = metaEdModel.data.edfiApiSchema.jsonSchemaForInsert.properties[keyValue]; - - if (property != null && property.type != null) { - if ((property && property?.type === 'integer') || property.type === 'number') { - const value = Number(queryParameters[keyValue]); - if (!Number.isNaN(value)) { - queryParameters[keyValue] = value; - } - } - if (property.type === 'boolean' && (queryParameters[keyValue] === 'true' || queryParameters[keyValue] === 'false')) { - queryParameters[keyValue] = Boolean(queryParameters[keyValue]); - } - } - }); - - const isValid: boolean = queryValidator(queryParameters); - - if (isValid) return []; - - if (queryValidator.errors) { - const ajvErrors = queryValidator.errors.map((error: ErrorObject) => { - // When a parameter name is invalid instancePath is null thus only - // shows the error message which looks like the following: ' must NOT have additional properties' - if (error.instancePath === '' && error.keyword === 'additionalProperties') { - return `${metaEdModel.metaEdName} does not include property '${error.params.additionalProperty}'`; - } - return `${error.instancePath} ${error.message}` ?? ''; - }); - - errors = [...errors, ...ajvErrors]; - } - - return errors; -} diff --git a/Meadowlark-js/packages/meadowlark-core/src/metaed/ResourceNameMapping.ts b/Meadowlark-js/packages/meadowlark-core/src/metaed/ResourceNameMapping.ts deleted file mode 100644 index 7cf8fdfe..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/metaed/ResourceNameMapping.ts +++ /dev/null @@ -1,136 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -/* eslint-disable no-restricted-syntax */ -import { - Association, - AssociationSubclass, - Descriptor, - DomainEntity, - DomainEntitySubclass, - MetaEdEnvironment, - normalizeDescriptorSuffix, - TopLevelEntity, -} from '@edfi/metaed-core'; -import { pluralize } from '@edfi/metaed-plugin-edfi-api-schema'; -import { decapitalize } from '../Utility'; - -/** - * A mapping of resource names to MetaEd models - */ -type ResourceNameToMetaEdModelMap = Map; - -/** - * A MetaEd project (AKA namespace) name - */ -type ProjectName = string; - -// simple cache implementation, see: https://rewind.io/blog/simple-caching-in-aws-lambda-functions/ -/** This is a cache of project names to a mapping of resource names to MetaEd model objects */ -let resourceMappingCache: Map = new Map(); - -/** - * For tests only - resets the resource mapping cache - */ -export function resetCache(): void { - resourceMappingCache = new Map(); -} - -/** - * Converts a MetaEd model name to its resource name - */ -function resourceNameFrom(metaEdName: string): string { - return pluralize(decapitalize(metaEdName)); -} - -/** - * Creates a mapping between resource names and the MetaEd model object that the resource - * refers to, for all model objects in the given MetaEd project. Caches the results for future calls. - * - * In the MetaEd internal model, each model object type in a project (namespace) is stored in a separate collection. - * For example, all core Domain Entities are in the collection "metaEd.namespace('EdFi').entity.domainEntity". - * We iterate through each model type that is expressed as an API resource. - */ -function getResourceNameMappingForNamespace(metaEd: MetaEdEnvironment, projectName: string): ResourceNameToMetaEdModelMap { - let resourceNameMapping: ResourceNameToMetaEdModelMap | undefined = resourceMappingCache.get(projectName); - if (resourceNameMapping != null) return resourceNameMapping; - - resourceNameMapping = new Map(); - - const domainEntities: IterableIterator | undefined = metaEd.namespace - .get(projectName) - ?.entity.domainEntity.values(); - if (domainEntities != null) { - for (const domainEntity of domainEntities) { - // Abstract entities are not resources (e.g. EducationOrganization) - if (!domainEntity.isAbstract) { - resourceNameMapping.set(resourceNameFrom(domainEntity.metaEdName), domainEntity); - } - } - } - - const associations: IterableIterator | undefined = metaEd.namespace - .get(projectName) - ?.entity.association.values(); - if (associations != null) { - for (const association of associations) { - // This is a workaround for the fact that the ODS/API required GeneralStudentProgramAssociation to - // be abstract although there is no MetaEd language annotation to make an Association abstract. - if (association.metaEdName !== 'GeneralStudentProgramAssociation') - resourceNameMapping.set(resourceNameFrom(association.metaEdName), association); - } - } - - const domainEntitySubclasses: IterableIterator | undefined = metaEd.namespace - .get(projectName) - ?.entity.domainEntitySubclass.values(); - if (domainEntitySubclasses != null) { - for (const domainEntitySubclass of domainEntitySubclasses) { - resourceNameMapping.set(resourceNameFrom(domainEntitySubclass.metaEdName), domainEntitySubclass); - } - } - - const associationSubclasses: IterableIterator | undefined = metaEd.namespace - .get(projectName) - ?.entity.associationSubclass.values(); - if (associationSubclasses != null) { - for (const associationSubclass of associationSubclasses) { - resourceNameMapping.set(resourceNameFrom(associationSubclass.metaEdName), associationSubclass); - } - } - - const descriptors: IterableIterator | undefined = metaEd.namespace - .get(projectName) - ?.entity.descriptor.values(); - if (descriptors != null) { - for (const descriptor of descriptors) { - resourceNameMapping.set(pluralize(normalizeDescriptorSuffix(decapitalize(descriptor.metaEdName))), descriptor); - } - } - - resourceMappingCache.set(projectName, resourceNameMapping); - return resourceNameMapping; -} - -/** - * Looks up the MetaEd model that a given resource name refers to, for a given MetaEd project. - * Returns top-level MetaEd entity matching the given resourceName, if it exists - */ -export function getMetaEdModelForResourceName( - resourceName: string, - metaEd: MetaEdEnvironment, - projectName: string, -): TopLevelEntity | undefined { - const localNamespace = projectName === 'ed-fi' ? 'EdFi' : projectName; - return getResourceNameMappingForNamespace(metaEd, localNamespace).get(resourceName); -} - -/** - * Returns all resource names for a given project name - */ -export function getResourceNamesForProject(metaEd: MetaEdEnvironment, projectName: string): string[] { - const adjustedProjectName = projectName === 'ed-fi' ? 'EdFi' : projectName; - return [...getResourceNameMappingForNamespace(metaEd, adjustedProjectName).keys()]; -} diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/AuthorizationMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/AuthorizationMiddleware.ts index b873b23a..ea6ebdf3 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/AuthorizationMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/AuthorizationMiddleware.ts @@ -59,7 +59,7 @@ type RequestOwnAccessTokenResult = { success: true; token: string } | { success: * or a FrontEndResponse with an error. */ async function requestOwnAccessToken(frontendRequest: FrontendRequest): Promise { - writeDebugStatusToLog(moduleName, frontendRequest, 'requestOwnAccessToken'); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'requestOwnAccessToken'); try { // Request a token for Meadowlark using configured OAuth server and configured Meadowlark credentials @@ -106,13 +106,13 @@ async function requestOwnAccessToken(frontendRequest: FrontendRequest): Promise< export async function authorize({ frontendRequest, frontendResponse }: MiddlewareModel): Promise { // if there is a response already posted, we are done if (frontendResponse != null) return { frontendRequest, frontendResponse }; - writeDebugStatusToLog(moduleName, frontendRequest, 'authorize'); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'authorize'); // if upstream has already provided security information, we are done if (frontendRequest.middleware.security !== UndefinedSecurity) { writeDebugStatusToLog( moduleName, - frontendRequest, + frontendRequest.traceId, 'authorize', undefined, 'credentials provided upstream, skipping OAuth server requests', @@ -125,7 +125,7 @@ export async function authorize({ frontendRequest, frontendResponse }: Middlewar if (clientBearerToken == null) { const statusCode = 400; - writeDebugStatusToLog(moduleName, frontendRequest, 'authorize', statusCode); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'authorize', statusCode); return { frontendRequest, frontendResponse: { @@ -143,7 +143,7 @@ export async function authorize({ frontendRequest, frontendResponse }: Middlewar if (isDebugEnabled()) { writeDebugStatusToLog( moduleName, - frontendRequest, + frontendRequest.traceId, 'authorize', undefined, `Client token authorized. Found ${clientBearerToken} in cache with remaining TTL ${getCachedClientsTokenInfo().getRemainingTTL( @@ -180,7 +180,7 @@ export async function authorize({ frontendRequest, frontendResponse }: Middlewar // Meadowlark own token is no longer valid -- most likely expired writeDebugStatusToLog( moduleName, - frontendRequest, + frontendRequest.traceId, 'authorize', undefined, `OAuth server responded that Meadowlark own token is not valid`, @@ -204,7 +204,7 @@ export async function authorize({ frontendRequest, frontendResponse }: Middlewar // Client-provided token is not a well-formed JWT writeDebugStatusToLog( moduleName, - frontendRequest, + frontendRequest.traceId, 'authorize', 400, 'verification response returned 400 - Client-provided token is not a JWT', @@ -219,7 +219,7 @@ export async function authorize({ frontendRequest, frontendResponse }: Middlewar if (!verificationResponse.data?.active) { // Client-provided token accepted by OAuth server but not active - writeDebugStatusToLog(moduleName, frontendRequest, 'authorize', 401, 'Client-provided token is inactive'); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'authorize', 401, 'Client-provided token is inactive'); return { frontendRequest, frontendResponse: { statusCode: 401 } }; } diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ExtractDocumentInfoMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ExtractDocumentInfoMiddleware.ts index 1a26ef2b..0b7a43ce 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ExtractDocumentInfoMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ExtractDocumentInfoMiddleware.ts @@ -30,7 +30,7 @@ export async function documentInfoExtraction({ if (documentInfo === NoDocumentInfo) { const statusCode = 404; - writeDebugStatusToLog(moduleName, frontendRequest, 'documentInfoExtraction', statusCode); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'documentInfoExtraction', statusCode); return { frontendRequest, frontendResponse: { statusCode, headers: frontendRequest.middleware.headerMetadata }, diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/FindMetaEdModelMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/FindMetaEdModelMiddleware.ts deleted file mode 100644 index e617d1d9..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/FindMetaEdModelMiddleware.ts +++ /dev/null @@ -1,39 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import { Logger } from '@edfi/meadowlark-utilities'; -import { writeDebugStatusToLog, writeRequestToLog } from '../Logger'; -import { MiddlewareModel } from './MiddlewareModel'; -import { findMetaEdModel } from '../metaed/MetaEdModelFinder'; - -const moduleName = 'core.middleware.FindMetaEdModelMiddleware'; - -/** - * Finds the matching MetaEd model from the path components - */ -export async function metaEdModelFinding({ frontendRequest, frontendResponse }: MiddlewareModel): Promise { - // if there is a response already posted, we are done - if (frontendResponse != null) return { frontendRequest, frontendResponse }; - writeRequestToLog(moduleName, frontendRequest, 'metaEdModelFinding'); - - const matchingMetaEdModel = await findMetaEdModel(frontendRequest.middleware.pathComponents); - if (matchingMetaEdModel == null) { - const errorMessage = `${moduleName}.metaEdModelFinding Fatal error - matchingMetaEdModel not found`; - Logger.error(errorMessage, frontendRequest.traceId); - const statusCode = 500; - writeDebugStatusToLog(moduleName, frontendRequest, 'metaEdModelFinding', statusCode, errorMessage); - return { - frontendRequest, - frontendResponse: { statusCode, headers: frontendRequest.middleware.headerMetadata }, - }; - } - Logger.debug( - `${moduleName}.metaEdModelMatching Found model ${matchingMetaEdModel.namespace.namespaceName}.${matchingMetaEdModel.metaEdName}`, - frontendRequest.traceId, - ); - - frontendRequest.middleware.matchingMetaEdModel = matchingMetaEdModel; - return { frontendRequest, frontendResponse: null }; -} diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ParseBodyMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ParseBodyMiddleware.ts index fb1273fa..2c47b41b 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ParseBodyMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ParseBodyMiddleware.ts @@ -18,7 +18,7 @@ export async function parseBody({ frontendRequest, frontendResponse }: Middlewar if (frontendRequest.body == null) { const error = 'Missing body'; - writeDebugStatusToLog(moduleName, frontendRequest, 'parseBody', 400, error); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'parseBody', 400, error); return { frontendRequest, frontendResponse: { body: { error }, statusCode: 400 } }; } @@ -27,7 +27,7 @@ export async function parseBody({ frontendRequest, frontendResponse }: Middlewar body = JSON.parse(frontendRequest.body); } catch (e) { const error = `Malformed body: ${e.message}`; - writeDebugStatusToLog(moduleName, frontendRequest, 'parseBody', 400, error); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'parseBody', 400, error); return { frontendRequest, frontendResponse: { body: { error }, statusCode: 400 } }; } diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ParsePathMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ParsePathMiddleware.ts index ca8c0f53..31872661 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ParsePathMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ParsePathMiddleware.ts @@ -8,6 +8,10 @@ import { isDocumentUuidWellFormed } from '../model/DocumentIdentity'; import type { PathComponents } from '../model/PathComponents'; import type { DocumentUuid } from '../model/IdTypes'; import type { MiddlewareModel } from './MiddlewareModel'; +import { decapitalize } from '../Utility'; +import { EndpointName } from '../model/api-schema/EndpointName'; +import { ProjectNamespace } from '../model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../model/ProjectShortVersion'; const moduleName = 'core.middleware.ParsePathMiddleware'; @@ -16,7 +20,8 @@ export function pathComponentsFrom(path: string): PathComponents | null { // /v3.3b/ed-fi/Sections // /v3.3b/ed-fi/Sections/ // /v3.3b/ed-fi/Sections/idValue - const pathExpression = /\/(?[^/]+)\/(?[^/]+)\/(?[^/]+)(\/|$)((?[^/]*$))?/gm; + const pathExpression = + /\/(?[^/]+)\/(?[^/]+)\/(?[^/]+)(\/|$)((?[^/]*$))?/gm; const match = pathExpression.exec(path); if (match?.groups == null) { @@ -26,9 +31,9 @@ export function pathComponentsFrom(path: string): PathComponents | null { const { documentUuid } = match.groups ?? null; return { - version: match.groups.version, - namespace: match.groups.namespace, - resourceName: match.groups.resource, + projectShortVersion: match.groups.projectShortVersion as ProjectShortVersion, + projectNamespace: match.groups.projectNamespace.toLowerCase() as ProjectNamespace, + endpointName: decapitalize(match.groups.endpointName) as EndpointName, documentUuid: documentUuid as DocumentUuid, }; } @@ -44,13 +49,13 @@ export async function parsePath({ frontendRequest, frontendResponse }: Middlewar const pathComponents: PathComponents | null = pathComponentsFrom(frontendRequest.path); if (pathComponents === null) { - writeDebugStatusToLog(moduleName, frontendRequest, 'parsePath', 404); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'parsePath', 404); return { frontendRequest, frontendResponse: { statusCode: 404 } }; } const { documentUuid } = pathComponents; if (documentUuid != null && !isDocumentUuidWellFormed(documentUuid)) { - writeDebugStatusToLog(moduleName, frontendRequest, 'parsePath', 404, `Malformed resource id ${documentUuid}`); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'parsePath', 404, `Malformed resource id ${documentUuid}`); return { frontendRequest, frontendResponse: { statusCode: 404 } }; } diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ResponseLoggingMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ResponseLoggingMiddleware.ts index b3271978..02760095 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ResponseLoggingMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ResponseLoggingMiddleware.ts @@ -5,7 +5,7 @@ import { Config } from '@edfi/meadowlark-utilities'; import * as R from 'ramda'; -import { writeDebugObject } from '../Logger'; +import { writeDebugStatusToLog } from '../Logger'; import { MissingIdentity } from '../model/DocumentIdentity'; import { MiddlewareModel } from './MiddlewareModel'; @@ -51,12 +51,13 @@ export async function logTheResponse({ frontendRequest, frontendResponse }: Midd } } - writeDebugObject( + writeDebugStatusToLog( moduleName, - frontendRequest, + frontendRequest.traceId, 'logTheResponse', frontendResponse?.statusCode, - R.is(String, responseBody) ? { error: responseBody } : responseBody, + typeof responseBody === 'string' ? responseBody : '', + typeof responseBody === 'object' ? responseBody : undefined, ); } diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/TimestampRequestMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/TimestampRequestMiddleware.ts index 8e2eb60e..e54d045e 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/TimestampRequestMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/TimestampRequestMiddleware.ts @@ -18,6 +18,11 @@ export async function timestampRequest({ frontendRequest, frontendResponse }: Mi writeRequestToLog(moduleName, frontendRequest, 'timestampRequest'); frontendRequest.middleware.timestamp = Date.now(); - writeDebugMessage(moduleName, frontendRequest, 'timestampRequest', `Timestamp: ${frontendRequest.middleware.timestamp}`); + writeDebugMessage( + moduleName, + 'timestampRequest', + frontendRequest.traceId, + `Timestamp: ${frontendRequest.middleware.timestamp}`, + ); return { frontendRequest, frontendResponse: null }; } diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateDocumentMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateDocumentMiddleware.ts index a04639fc..fe5bfdb6 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateDocumentMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateDocumentMiddleware.ts @@ -4,7 +4,7 @@ // See the LICENSE and NOTICES files in the project root for more information. import { validateDocument } from '../validation/DocumentValidator'; -import { writeDebugObject, writeRequestToLog } from '../Logger'; +import { writeDebugStatusToLog, writeRequestToLog } from '../Logger'; import { MiddlewareModel } from './MiddlewareModel'; const moduleName = 'core.middleware.ValidateDocumentMiddleware'; @@ -17,15 +17,15 @@ export async function documentValidation({ frontendRequest, frontendResponse }: // if there is a response already posted, we are done if (frontendResponse != null) return { frontendRequest, frontendResponse }; writeRequestToLog(moduleName, frontendRequest, 'documentValidation'); - const error: object | null = await validateDocument( + const error: object | null = validateDocument( + frontendRequest.middleware.resourceSchema, frontendRequest.middleware.parsedBody, - frontendRequest.middleware.matchingMetaEdModel, isUpdate, ); if (error != null) { const statusCode = 400; - writeDebugObject(moduleName, frontendRequest, 'documentValidation', statusCode, error); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'documentValidation', statusCode, '', error); return { frontendRequest, frontendResponse: { body: error, statusCode, headers: frontendRequest.middleware.headerMetadata }, diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateResourceMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateEndpointMiddleware.ts similarity index 63% rename from Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateResourceMiddleware.ts rename to Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateEndpointMiddleware.ts index 698bb563..c727ca54 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateResourceMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateEndpointMiddleware.ts @@ -3,7 +3,7 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import { validateResource } from '../validation/ResourceValidator'; +import { validateEndpoint } from '../validation/EndpointValidator'; import { writeDebugStatusToLog, writeRequestToLog } from '../Logger'; import { MiddlewareModel } from './MiddlewareModel'; import { NoResourceInfo } from '../model/ResourceInfo'; @@ -13,23 +13,23 @@ const moduleName = 'core.middleware.ValidateResourceMiddleware'; /** * Validates resource */ -export async function resourceValidation({ frontendRequest, frontendResponse }: MiddlewareModel): Promise { +export async function endpointValidation({ frontendRequest, frontendResponse }: MiddlewareModel): Promise { // if there is a response already posted, we are done if (frontendResponse != null) return { frontendRequest, frontendResponse }; writeRequestToLog(moduleName, frontendRequest, 'resourceValidation'); - const { - resourceInfo, - errorBody: error, - headerMetadata, - } = await validateResource(frontendRequest.middleware.pathComponents); + const { resourceSchema, resourceInfo, errorBody, headerMetadata } = await validateEndpoint( + frontendRequest.middleware.pathComponents, + frontendRequest.traceId, + ); - if (error != null) { + if (errorBody != null) { const statusCode = resourceInfo === NoResourceInfo ? 404 : 400; - writeDebugStatusToLog(moduleName, frontendRequest, 'resourceValidation', statusCode, undefined, error); - return { frontendRequest, frontendResponse: { body: error, statusCode, headers: headerMetadata } }; + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'resourceValidation', statusCode, undefined, errorBody); + return { frontendRequest, frontendResponse: { body: errorBody, statusCode, headers: headerMetadata } }; } + frontendRequest.middleware.resourceSchema = resourceSchema; frontendRequest.middleware.resourceInfo = resourceInfo; frontendRequest.middleware.headerMetadata = headerMetadata; return { frontendRequest, frontendResponse: null }; diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateEqualityConstraintMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateEqualityConstraintMiddleware.ts index 5a993727..6a05a18f 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateEqualityConstraintMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateEqualityConstraintMiddleware.ts @@ -3,7 +3,7 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import { writeDebugObject, writeRequestToLog } from '../Logger'; +import { writeDebugStatusToLog, writeRequestToLog } from '../Logger'; import { validateEqualityConstraints } from '../validation/EqualityConstraintValidator'; import { MiddlewareModel } from './MiddlewareModel'; @@ -22,14 +22,14 @@ export async function equalityConstraintValidation({ writeRequestToLog(moduleName, frontendRequest, 'equalityConstraintValidation'); const validationFailures: string[] = validateEqualityConstraints( - frontendRequest.middleware.matchingMetaEdModel, + frontendRequest.middleware.resourceSchema, frontendRequest.middleware.parsedBody, ); if (validationFailures.length > 0) { const error = { error: validationFailures }; const statusCode = 400; - writeDebugObject(moduleName, frontendRequest, 'documentValidation', statusCode, error); + writeDebugStatusToLog(moduleName, frontendRequest.traceId, 'documentValidation', statusCode, '', error); return { frontendRequest, frontendResponse: { body: error, statusCode, headers: frontendRequest.middleware.headerMetadata }, diff --git a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateQueryMiddleware.ts b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateQueryMiddleware.ts index 1e0bf672..e0eaea17 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateQueryMiddleware.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/middleware/ValidateQueryMiddleware.ts @@ -40,7 +40,7 @@ export async function queryValidation({ frontendRequest, frontendResponse }: Mid const removeDisallowedQueryParameters = R.omit(['offset', 'limit', 'totalCount']); const queryParameters = removeDisallowedQueryParameters(frontendRequest.queryParameters); - const { errorBody } = await validateQueryString(queryParameters, frontendRequest.middleware.matchingMetaEdModel); + const { errorBody } = await validateQueryString(queryParameters, frontendRequest.middleware.resourceSchema); if (errorBody != null) { const statusCode = 400; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/BrandType.ts b/Meadowlark-js/packages/meadowlark-core/src/model/BrandType.ts new file mode 100644 index 00000000..194ad721 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/BrandType.ts @@ -0,0 +1,9 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +// This is a generic "brand" type used to create branded types from strings +// Note this is a pure Typescript construct. The __brand property and usage of +// string literals for T do not exist after transpile. +export type Brand = K & { __brand: T }; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/DocumentIdentity.ts b/Meadowlark-js/packages/meadowlark-core/src/model/DocumentIdentity.ts index c529e1ba..4c272fd9 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/model/DocumentIdentity.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/model/DocumentIdentity.ts @@ -3,7 +3,6 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import { normalizeDescriptorSuffix } from '@edfi/metaed-core'; import crypto from 'node:crypto'; import { DocumentUuid, MeadowlarkId } from './IdTypes'; import type { BaseResourceInfo } from './ResourceInfo'; @@ -49,10 +48,8 @@ function toHash(data: string, lengthInBytes: number): string { /** * Returns the 12 byte SHAKE256 Base64Url encoded hash form of a ResourceInfo. */ -export function resourceInfoHashFrom({ projectName, resourceName, isDescriptor }: BaseResourceInfo) { - const normalizedResourceName = isDescriptor ? normalizeDescriptorSuffix(resourceName) : resourceName; - const resourceInfoString = `${projectName}#${normalizedResourceName}`; - return toHash(resourceInfoString, 12); +export function resourceInfoHashFrom({ projectName, resourceName }: BaseResourceInfo) { + return toHash(`${projectName}#${resourceName}`, 12); } /** diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/IdTypes.ts b/Meadowlark-js/packages/meadowlark-core/src/model/IdTypes.ts index ebe8d17a..c9954a71 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/model/IdTypes.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/model/IdTypes.ts @@ -3,10 +3,7 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -// This is a generic "brand" type used to create branded types from strings -// Note this is a pure Typescript construct. The __brand property and usage of -// string literals for T do not exist after transpile. -type Brand = K & { __brand: T }; +import { Brand } from './BrandType'; // A string type branded as a documentUuid export type DocumentUuid = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/PathComponents.ts b/Meadowlark-js/packages/meadowlark-core/src/model/PathComponents.ts index 1a7c42a4..58523ed7 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/model/PathComponents.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/model/PathComponents.ts @@ -4,32 +4,47 @@ // See the LICENSE and NOTICES files in the project root for more information. import { DocumentUuid } from './IdTypes'; +import { ProjectShortVersion } from './ProjectShortVersion'; +import { EndpointName } from './api-schema/EndpointName'; +import { ProjectNamespace } from './api-schema/ProjectNamespace'; +/** + * The important parts of the request URL in object form + */ export type PathComponents = { /** - * Data standard version number + * Shortened project version number e.g. "v3.3b" */ - version: string; + projectShortVersion: ProjectShortVersion; + /** - * Data standard namespace + * Project namespace, all lowercased */ - namespace: string; + projectNamespace: ProjectNamespace; + /** - * Endpoint name (resource) + * Endpoint name, which has been decapitalized */ - resourceName: string; + endpointName: EndpointName; + /** * The resource identifier, which is a document uuid */ documentUuid?: DocumentUuid; }; -export function newPathComponents() { +/** + * Create a new PathComponents + */ +export function newPathComponents(): PathComponents { return { - version: '', - namespace: '', - resourceName: '', + projectShortVersion: '' as ProjectShortVersion, + projectNamespace: '' as ProjectNamespace, + endpointName: '' as EndpointName, }; } -export const NoPathComponents = Object.freeze(newPathComponents()); +/** + * The null object for PathComponents + */ +export const NoPathComponents: PathComponents = Object.freeze(newPathComponents()); diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/ProjectShortVersion.ts b/Meadowlark-js/packages/meadowlark-core/src/model/ProjectShortVersion.ts new file mode 100644 index 00000000..d66fd4d7 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/ProjectShortVersion.ts @@ -0,0 +1,12 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. +import { Brand } from './BrandType'; + +/** + * A string type branded as a ProjectShortVersion, which is a shortened form of a project version + * e.g. "v3.3b" for the Ed-Fi data standard version "3.3.1-b". + */ + +export type ProjectShortVersion = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/ResourceInfo.ts b/Meadowlark-js/packages/meadowlark-core/src/model/ResourceInfo.ts index 9ce12ee0..6c073415 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/model/ResourceInfo.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/model/ResourceInfo.ts @@ -4,11 +4,11 @@ // See the LICENSE and NOTICES files in the project root for more information. /** - * Base API resource information + * Base API resource information for passing along to backends */ export interface BaseResourceInfo { /** - * The MetaEd project name the API document resource is defined in e.g. "EdFi" for a data standard entity. + * The project name the API document resource is defined in e.g. "EdFi" for a data standard entity. */ projectName: string; @@ -17,6 +17,7 @@ export interface BaseResourceInfo { * there are exceptions, for example descriptors have a "Descriptor" suffix on their resource name. */ resourceName: string; + /** * Whether this resource is a descriptor. Descriptors are treated differently from other documents */ @@ -28,7 +29,7 @@ export interface BaseResourceInfo { */ export interface ResourceInfo extends BaseResourceInfo { /** - * The MetaEd project version the entity belongs to. + * The project version the resource belongs to. */ resourceVersion: string; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/ResourceMatchResult.ts b/Meadowlark-js/packages/meadowlark-core/src/model/ResourceMatchResult.ts deleted file mode 100644 index 27594771..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/model/ResourceMatchResult.ts +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import { TopLevelEntity } from '@edfi/metaed-core'; - -/** The result of an attempt to match a resource name to a MetaEd model object */ -export type ResourceMatchResult = { - /** - * The resource name resulting from the match attempt. Either an exact match, a suggestion, - * or the empty string - */ - resourceName: string; - - /** - * Whether this match is with a descriptor - */ - isDescriptor: boolean; - - /** - * True if the resourceName is an exact match - */ - exact: boolean; - - /** - * True if the resourceName is a suggestion - */ - suggestion: boolean; - - /** - * If resourceName is an exact match, this is the matching MetaEd model object. - * Otherwise, it's a null object. - */ - matchingMetaEdModel: TopLevelEntity; -}; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ApiSchema.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ApiSchema.ts new file mode 100644 index 00000000..f6dcf325 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ApiSchema.ts @@ -0,0 +1,20 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { ProjectSchemaMapping } from './ProjectSchemaMapping'; + +/** + * API information + */ +export type ApiSchema = { + /** + * A collection of ProjectNamespaces mapped to ProjectSchema objects + */ + projectSchemas: ProjectSchemaMapping; +}; + +export function newApiSchema(): ApiSchema { + return { projectSchemas: {} }; +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentObjectKey.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentObjectKey.ts new file mode 100644 index 00000000..497db03e --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentObjectKey.ts @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { Brand } from '../BrandType'; + +/** + * A string type branded as a DocumentObjectKey, which is standard JSON document object key + */ +export type DocumentObjectKey = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPaths.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPaths.ts new file mode 100644 index 00000000..ebdc7c38 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPaths.ts @@ -0,0 +1,71 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { DocumentObjectKey } from './DocumentObjectKey'; +import { JsonPath } from './JsonPath'; + +type BaseDocumentPaths = { + /** + * A mapping of unique DocumentObjectKeys to JsonPaths. This is used as a building block for document identities + * and document references, where the JsonPaths can later be turned into the values in a document, and the keys + * indicate what the value represents. + * + * As an example, these are the JsonPaths for CourseOffering on Section, a reference with four fields: + * + * { + * localCourseCode: '$.courseOfferingReference.localCourseCode', + * schoolId: '$.courseOfferingReference.schoolId', + * schoolYear: '$.courseOfferingReference.schoolYear', + * sessionName: '$.courseOfferingReference.sessionName', + * } + */ + paths: { [key: DocumentObjectKey]: JsonPath }; + + /** + * An ordering of the paths by DocumentObjectKey, used to ensure consistent ordering downstream. + */ + pathOrder: DocumentObjectKey[]; +}; + +/** + * JsonPath information for a reference MetaEd property + */ +export type ReferencePaths = BaseDocumentPaths & { + /** + * Discriminator between reference and scalar path types + */ + isReference: true; + + /** + * The MetaEd project name the referenced API resource is defined in e.g. "EdFi" for a data standard entity. + */ + projectName: string; + + /** + * The name of the referenced API resource. Typically, this is the same as the corresponding MetaEd entity name. However, + * there are exceptions, for example descriptors have a "Descriptor" suffix on their resource name. + */ + resourceName: string; + + /** + * Whether this reference is a descriptor. Descriptors are treated differently from other documents + */ + isDescriptor: boolean; +}; + +/** + * A JsonPath for a scalar MetaEd property + */ +export type ScalarPath = BaseDocumentPaths & { + /** + * Discriminator between reference and scalar path types + */ + isReference: false; +}; + +/** + * DocumentPaths provides JsonPaths to values corresponding to reference and scalar MetaEd properties in a resource document. + */ +export type DocumentPaths = ReferencePaths | ScalarPath; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPathsMapping.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPathsMapping.ts new file mode 100644 index 00000000..11aba79a --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/DocumentPathsMapping.ts @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { DocumentPaths } from './DocumentPaths'; +import { MetaEdPropertyFullName } from './MetaEdPropertyFullName'; + +/** + */ +export type DocumentPathsMapping = { [key: MetaEdPropertyFullName]: DocumentPaths }; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EndpointName.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EndpointName.ts new file mode 100644 index 00000000..28cd19a8 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EndpointName.ts @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { Brand } from '../BrandType'; + +/** + * A string type branded as an EndpointName, which is the name of an API resource endpoint. Typically, this is the same + * as a decapitalized MetaEd entity name. However, there are exceptions, for example descriptors have a + * "Descriptor" suffix on their endpoint name. + */ + +export type EndpointName = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EqualityConstraint.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EqualityConstraint.ts new file mode 100644 index 00000000..d1f2ab3a --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/EqualityConstraint.ts @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { JsonPath } from './JsonPath'; + +/** + * A pair of JsonPaths, the value of which must be equal in an Ed-Fi API JSON document. + */ +export type EqualityConstraint = { + sourceJsonPath: JsonPath; + targetJsonPath: JsonPath; +}; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonPath.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonPath.ts new file mode 100644 index 00000000..8e8101e8 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonPath.ts @@ -0,0 +1,8 @@ +import { Brand } from '../BrandType'; + +/** + * A string type branded as a JsonPath, which is a standard JSONPath expression. + * See https://goessner.net/articles/JsonPath/index.html + */ + +export type JsonPath = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonSchema.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonSchema.ts new file mode 100644 index 00000000..e2f2790c --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/JsonSchema.ts @@ -0,0 +1,63 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +/* eslint-disable no-use-before-define */ // Due to recursive references + +/** + * SchemaProperty is either an object, array, or simple type + */ +export type SchemaProperty = + | SchemaObject + | SchemaArray + | { type: 'string'; description: string; format?: 'date' | 'date-time' | 'time'; minLength?: number; maxLength?: number } + | { type: 'integer'; description: string; minimum?: number; maximum?: number } + | { type: 'number'; description: string; minimum?: number; maximum?: number } + | { type: 'boolean'; description: string }; + +/** + * The set of properties on a SchemaObject. + */ +export type SchemaProperties = { [propertyName: string]: SchemaProperty }; + +/** + * SchemaObject is the SchemaProperty representing an object, which has properties + */ +export type SchemaObject = { + type: 'object'; + description?: string; + properties: SchemaProperties; + additionalProperties: boolean; + required?: string[]; +}; + +/** + * SchemaArray is the SchemaProperty representing an array, which has items + */ +export type SchemaArray = { + type: 'array'; + description?: string; + items: SchemaProperty; + minItems: number; + uniqueItems: false; +}; + +/** + * A SchemaRoot is a SchemaObject with additional header fields + */ +export type SchemaRoot = SchemaObject & { + $schema: string; + title: string; +}; + +/** + * The SchemaRoot null object + */ +export const NoSchemaRoot: SchemaRoot = Object.freeze({ + type: 'object', + properties: {}, + additionalProperties: false, + $schema: '', + title: 'NoSchemaRoot', +}); diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdProjectName.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdProjectName.ts new file mode 100644 index 00000000..e15e33b6 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdProjectName.ts @@ -0,0 +1,12 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. +import { Brand } from '../BrandType'; + +/** + * A string type branded as a MetaEdProjectName, which is the MetaEd project name for a collection of + * API resources, e.g. "EdFi" for an Ed-Fi data standard version. + */ + +export type MetaEdProjectName = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyFullName.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyFullName.ts new file mode 100644 index 00000000..048aa607 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyFullName.ts @@ -0,0 +1,13 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { Brand } from '../BrandType'; + +/** + * A string type branded as a MetaEdPropertyFullName, which is the full property name of a MetaEd + * property on a MetaEd entity. Role names on a property are expressed by prefix on the property name. + */ + +export type MetaEdPropertyFullName = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyPath.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyPath.ts new file mode 100644 index 00000000..9a57c308 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdPropertyPath.ts @@ -0,0 +1,13 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { Brand } from '../BrandType'; + +/** + * A string type branded as a MetaEdPropertyPath, which is a dot-separated MetaEd property name list + * denoting a path from a starting entity through other entities. Role names on a property + * are expressed by prefix on the property name. Most commonly used as a merge directive path. + */ +export type MetaEdPropertyPath = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdResourceName.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdResourceName.ts new file mode 100644 index 00000000..1e41f747 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/MetaEdResourceName.ts @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { Brand } from '../BrandType'; + +/** + * A string type branded as a MetaEdResourceName, which is the name of an API resource. Typically, this is the same + * as the corresponding MetaEd entity name. However, there are exceptions, for example descriptors have a + * "Descriptor" suffix on their resource name. + */ + +export type MetaEdResourceName = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectNamespace.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectNamespace.ts new file mode 100644 index 00000000..56f62978 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectNamespace.ts @@ -0,0 +1,12 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. +import { Brand } from '../BrandType'; + +/** + * A string type branded as a ProjectNamespace, which is the URI path component referring to a ProjectSchema + * e.g. "ed-fi" for an Ed-Fi data standard version. + */ + +export type ProjectNamespace = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchema.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchema.ts new file mode 100644 index 00000000..bf1e3ad1 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchema.ts @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { ResourceSchema } from './ResourceSchema'; +import { ResourceSchemaMapping } from './ResourceSchemaMapping'; +import { SemVer } from './SemVer'; + +/** + * API project information + */ +export type ProjectSchema = { + /** + * The MetaEd project name the referenced API resource is defined in e.g. "EdFi" for a data standard entity. + */ + projectName: string; + projectVersion: SemVer; + isExtensionProject: boolean; + description: string; + + /** + * A collection of EndpointNames mapped to ResourceSchema objects. + */ + resourceSchemas: ResourceSchemaMapping; + + /** + * SchoolYearEnumeration is not a resource but has a ResourceSchema + */ + schoolYearEnumeration?: ResourceSchema; +}; + +export const NoProjectSchema: ProjectSchema = { + projectName: 'NoProjectName', + projectVersion: '0.0.0' as SemVer, + isExtensionProject: false, + description: 'NoProjectSchema', + resourceSchemas: {}, +}; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchemaMapping.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchemaMapping.ts new file mode 100644 index 00000000..74075aae --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ProjectSchemaMapping.ts @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { ProjectNamespace } from './ProjectNamespace'; +import { ProjectSchema } from './ProjectSchema'; + +/** + * A collection of ProjectNamespaces mapped to ProjectSchema objects. + */ +export type ProjectSchemaMapping = { + [key: ProjectNamespace]: ProjectSchema; +}; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchema.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchema.ts new file mode 100644 index 00000000..38a45a87 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchema.ts @@ -0,0 +1,121 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { EqualityConstraint } from './EqualityConstraint'; +import { DocumentPaths } from './DocumentPaths'; +import { NoSchemaRoot, SchemaRoot } from './JsonSchema'; +import { MetaEdPropertyFullName } from './MetaEdPropertyFullName'; +import { MetaEdResourceName } from './MetaEdResourceName'; +import { MetaEdProjectName } from './MetaEdProjectName'; + +/** + * API resource schema information common between regular and subclass resources + */ +export type BaseResourceSchema = { + /** + * The resource name. Typically, this is the entity metaEdName. + */ + resourceName: MetaEdResourceName; + + /** + * Whether this resource is a descriptor. Descriptors are treated differently from other resources + */ + isDescriptor: boolean; + + /** + * Whether API clients are permitted to modify the identity of an existing resource document. + */ + allowIdentityUpdates: boolean; + + /** + * The API document JSON schema that corresponds to this resource on insert. + */ + jsonSchemaForInsert: SchemaRoot; + + /** + * The API document JSON schema that corresponds to this resource on update. + */ + jsonSchemaForUpdate: SchemaRoot; + + /** + * The API document JSON schema that corresponds to this resource on query. + */ + jsonSchemaForQuery: SchemaRoot; + + /** + * A list of EqualityConstraints to be applied to a resource document. An EqualityConstraint + * is a source/target JsonPath pair. + */ + equalityConstraints: EqualityConstraint[]; + + /** + * A list of the MetaEd property fullnames for each property that is part of the identity + * for this resource, in lexical order + */ + identityFullnames: MetaEdPropertyFullName[]; + + /** + * A collection of MetaEd property fullnames mapped to DocumentPaths objects, + * which provide JsonPaths to the corresponding values in a resource document. + */ + documentPathsMapping: { [key: MetaEdPropertyFullName]: DocumentPaths }; +}; + +/** + * The additional ResourceSchema fields for an Association subclass + */ +export type AssociationSubclassResourceSchema = BaseResourceSchema & { + /** + * The project name and resource name for the superclass + */ + superclassProjectName: MetaEdProjectName; + superclassResourceName: MetaEdResourceName; +}; + +/** + * The additional ResourceSchema fields for a DomainEntity subclass + */ +export type DomainEntitySubclassResourceSchema = AssociationSubclassResourceSchema & { + /** + * The superclass identity field and the matching subclass identity field name. + * This is found in MetaEd as an "identity rename". MetaEd only allows the super/subclass + * relationship of Domain Entities to have a single common identity field. + */ + superclassIdentityFullname: MetaEdPropertyFullName; + subclassIdentityFullname: MetaEdPropertyFullName; +}; + +/** + * API resource schema information as a whole, with "isSubclass" as a differentiator between + * regular and subclass resources. + */ +export type ResourceSchema = + | (BaseResourceSchema & { + isSubclass: false; + }) + | (AssociationSubclassResourceSchema & { + isSubclass: true; + subclassType: 'association'; + }) + | (DomainEntitySubclassResourceSchema & { + isSubclass: true; + subclassType: 'domainEntity'; + }); + +/** + * The ResourceSchema null object + */ +export const NoResourceSchema: ResourceSchema = Object.freeze({ + resourceName: 'NoResourceSchema' as MetaEdResourceName, + isDescriptor: false, + allowIdentityUpdates: false, + jsonSchemaForInsert: NoSchemaRoot, + jsonSchemaForUpdate: NoSchemaRoot, + jsonSchemaForQuery: NoSchemaRoot, + equalityConstraints: [], + identityFullnames: [], + documentPathsMapping: {}, + isSubclass: false, +}); diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchemaMapping.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchemaMapping.ts new file mode 100644 index 00000000..67a8ab4e --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/ResourceSchemaMapping.ts @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { EndpointName } from './EndpointName'; +import { ResourceSchema } from './ResourceSchema'; + +/** + * A collection of EndpointNames mapped to ResourceSchema objects. + */ +export type ResourceSchemaMapping = { + [key: EndpointName]: ResourceSchema; +}; diff --git a/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/SemVer.ts b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/SemVer.ts new file mode 100644 index 00000000..f50062d1 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/model/api-schema/SemVer.ts @@ -0,0 +1,13 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { Brand } from '../BrandType'; + +/** + * A string type branded as a SemVer, which is a semantic version string. + * See https://semver.org/spec/v2.0.0.html + */ + +export type SemVer = Brand; diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/DocumentValidator.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/DocumentValidator.ts index 8ec8ed68..fd85b967 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/validation/DocumentValidator.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/validation/DocumentValidator.ts @@ -2,22 +2,34 @@ // Licensed to the Ed-Fi Alliance under one or more agreements. // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import { TopLevelEntity } from '@edfi/metaed-core'; -import type { ValidationError } from '@apideck/better-ajv-errors'; -import { validateEntityBodyAgainstSchema } from '../metaed/MetaEdValidation'; +import { betterAjvErrors, type ValidationError } from '@apideck/better-ajv-errors'; +import { ValidateFunction } from 'ajv'; +import { ResourceSchema } from '../model/api-schema/ResourceSchema'; +import { ResourceSchemaValidators, getSchemaValidatorsFor } from './ResourceSchemaValidation'; export type ValidationFailure = { error: ValidationError[] | null }; /** - * Performs validation of a document against a resource. - * - * Validates the request body for the resource. If invalid, returns an error message. + * Validate the JSON body of the request against the JSON schema for the corresponding API resource */ -export async function validateDocument( +export function validateDocument( + resourceSchema: ResourceSchema, body: object, - matchingMetaEdModel: TopLevelEntity, isUpdate: boolean = false, -): Promise { - const validationErrors: ValidationError[] | null = validateEntityBodyAgainstSchema(matchingMetaEdModel, body, isUpdate); +): ValidationFailure | null { + const resourceValidators: ResourceSchemaValidators = getSchemaValidatorsFor(resourceSchema); + const validator: ValidateFunction = isUpdate ? resourceValidators.updateValidator : resourceValidators.insertValidator; + + const isValid: boolean = validator(body); + + if (isValid) return null; + + const validationErrors: ValidationError[] | null = betterAjvErrors({ + data: body, + schema: isUpdate ? resourceSchema.jsonSchemaForUpdate : resourceSchema.jsonSchemaForInsert, + errors: validator.errors, + basePath: '{requestBody}', + }); + return validationErrors == null ? null : { error: validationErrors }; } diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidationResult.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidationResult.ts new file mode 100644 index 00000000..225345f4 --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidationResult.ts @@ -0,0 +1,27 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import { ResourceInfo } from '../model/ResourceInfo'; +import { ResourceSchema } from '../model/api-schema/ResourceSchema'; + +export type EndpointValidationResult = { + /** + * Metadata for the MetaEd project loaded + */ + headerMetadata?: any; + /** + * Error message for validation failure + */ + errorBody?: {}; + /** + * Information on the validated MetaEd entity matching the API request + */ + resourceInfo: ResourceInfo; + + /** + * The ResourceSchema for the endpoint + */ + resourceSchema: ResourceSchema; +}; diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidator.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidator.ts new file mode 100644 index 00000000..9c845eea --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/validation/EndpointValidator.ts @@ -0,0 +1,96 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import didYouMean from 'didyoumean2'; +import { PathComponents } from '../model/PathComponents'; +import { NoResourceInfo } from '../model/ResourceInfo'; +import { TraceId } from '../model/IdTypes'; +import { NoResourceSchema, ResourceSchema } from '../model/api-schema/ResourceSchema'; +import { findResourceSchema } from '../api-schema/ResourceSchemaFinder'; +import { findProjectSchema, validEndpointNamesFor } from '../api-schema/ProjectSchemaFinder'; +import { EndpointName } from '../model/api-schema/EndpointName'; +import { ProjectSchema } from '../model/api-schema/ProjectSchema'; +import { EndpointValidationResult } from './EndpointValidationResult'; + +/** The result of an attempt to match an EndpointName with a ResourceSchema */ +type MatchResourceSchemaResult = { + /** + * If the endpointName is not a match but a suggestion was available, this is the suggested EndpointName + */ + suggestedEndpointName?: EndpointName; + + /** + * If endpointName is an exact match this is the matching ResourceSchema. + */ + matchingResourceSchema?: ResourceSchema; +}; + +/** + * Finds the ResourceSchema that matches the EndpointName of the API request, or provides a suggestion + * if no match is found. + */ +async function matchResourceSchema(pathComponents: PathComponents, traceId: TraceId): Promise { + const matchingResourceSchema: ResourceSchema | undefined = await findResourceSchema(pathComponents, traceId); + if (matchingResourceSchema != null) { + return { matchingResourceSchema }; + } + + const suggestion = didYouMean( + pathComponents.endpointName, + validEndpointNamesFor(pathComponents.projectNamespace, pathComponents.projectShortVersion), + ); + if (suggestion == null) return {}; + + const suggestedEndpointName = Array.isArray(suggestion) ? suggestion[0] : suggestion; + return { suggestedEndpointName }; +} + +/** + * Validates that an endpoint maps to a ResourceSchema + */ +export async function validateEndpoint(pathComponents: PathComponents, traceId: TraceId): Promise { + const { matchingResourceSchema, suggestedEndpointName } = await matchResourceSchema(pathComponents, traceId); + + if (suggestedEndpointName !== null) { + const invalidResourceMessage = `Invalid resource '${pathComponents.endpointName}'. The most similar resource is '${suggestedEndpointName}'.`; + + return { + resourceSchema: NoResourceSchema, + resourceInfo: NoResourceInfo, + errorBody: { + error: invalidResourceMessage, + }, + }; + } + + if (matchingResourceSchema == null) { + return { + resourceSchema: NoResourceSchema, + resourceInfo: NoResourceInfo, + errorBody: { error: `Invalid resource '${pathComponents.endpointName}'.` }, + }; + } + + const projectSchema: ProjectSchema = await findProjectSchema( + pathComponents.projectNamespace, + pathComponents.projectShortVersion, + traceId, + ); + + return { + resourceSchema: matchingResourceSchema, + resourceInfo: { + projectName: projectSchema.projectName, + resourceVersion: projectSchema.projectVersion, + resourceName: matchingResourceSchema.resourceName, + isDescriptor: matchingResourceSchema.isDescriptor, + allowIdentityUpdates: matchingResourceSchema.allowIdentityUpdates, + }, + headerMetadata: { + 'X-Project-Name': projectSchema.projectName, + 'X-Project-Version': projectSchema.projectVersion, + }, + }; +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/EqualityConstraintValidator.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/EqualityConstraintValidator.ts index cfcbcda5..c6229c4e 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/validation/EqualityConstraintValidator.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/validation/EqualityConstraintValidator.ts @@ -3,8 +3,8 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. import { JSONPath as jsonPath } from 'jsonpath-plus'; -import { TopLevelEntity } from '@edfi/metaed-core'; -import type { EntityApiSchemaData, EqualityConstraint } from '@edfi/metaed-plugin-edfi-api-schema'; +import { ResourceSchema } from '../model/api-schema/ResourceSchema'; +import { EqualityConstraint } from '../model/api-schema/EqualityConstraint'; // By using the jsonpath library's "flatten" flag, we should only get back primitive types in the array type PrimitiveType = number | string | boolean; @@ -24,12 +24,10 @@ function allEqual(array: PrimitiveType[]): boolean { * * Returns a list of validation failure messages. */ -export function validateEqualityConstraints(matchingMetaEdModel: TopLevelEntity, parsedBody: any): string[] { +export function validateEqualityConstraints(resourceSchema: ResourceSchema, parsedBody: any): string[] { const validationFailures: string[] = []; - const { equalityConstraints } = matchingMetaEdModel.data.edfiApiSchema as EntityApiSchemaData; - - equalityConstraints.forEach((equalityConstraint: EqualityConstraint) => { + resourceSchema.equalityConstraints.forEach((equalityConstraint: EqualityConstraint) => { const sourceValues: PrimitiveType[] = jsonPath({ path: equalityConstraint.sourceJsonPath, json: parsedBody, diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/QueryStringValidator.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/QueryStringValidator.ts index 284182f8..99b6a24c 100644 --- a/Meadowlark-js/packages/meadowlark-core/src/validation/QueryStringValidator.ts +++ b/Meadowlark-js/packages/meadowlark-core/src/validation/QueryStringValidator.ts @@ -2,10 +2,11 @@ // Licensed to the Ed-Fi Alliance under one or more agreements. // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import { TopLevelEntity } from '@edfi/metaed-core'; +import { ErrorObject } from 'ajv'; import { FrontendQueryParameters } from '../handler/FrontendRequest'; -import { validateQueryParametersAgainstSchema } from '../metaed/MetaEdValidation'; +import { ResourceSchema } from '../model/api-schema/ResourceSchema'; import { createInvalidRequestResponse } from '../Utility'; +import { getSchemaValidatorsFor } from './ResourceSchemaValidation'; export type QueryStringValidationResult = { /** @@ -15,13 +16,64 @@ export type QueryStringValidationResult = { }; /** - * Validates that the provided query string belongs with the MetaEd resource specified by the PathComponents. + * Validates that those queryParameters which are present are actually fields on the API resource + */ +function validateQueryParameters(resourceSchema: ResourceSchema, queryParameters: FrontendQueryParameters): string[] { + const { queryValidator } = getSchemaValidatorsFor(resourceSchema); + + let errors: string[] = []; + + /** + * Number and boolean are come through as strings, which causes ajv to fail validation of parameters + * This loops through all query parameters and checks the type against the schema, if the type is numeric or boolean + * it will attempt convert the value. If the conversion is good, we set the value back and ajv will validate the schema + * If the value can't be converted (i.e. a word is provided for a numeric value, we leave it and let ajv invalidate + * the schema). + */ + Object.keys(queryParameters).forEach((keyValue) => { + const property = resourceSchema.jsonSchemaForQuery.properties[keyValue]; + + if (property != null && property.type != null) { + if ((property && property?.type === 'integer') || property.type === 'number') { + const value = Number(queryParameters[keyValue]); + if (!Number.isNaN(value)) { + queryParameters[keyValue] = value; + } + } + if (property.type === 'boolean' && (queryParameters[keyValue] === 'true' || queryParameters[keyValue] === 'false')) { + queryParameters[keyValue] = Boolean(queryParameters[keyValue]); + } + } + }); + + const isValid: boolean = queryValidator(queryParameters); + + if (isValid) return []; + + if (queryValidator.errors) { + const ajvErrors = queryValidator.errors.map((error: ErrorObject) => { + // When a parameter name is invalid instancePath is null thus only + // shows the error message which looks like the following: ' must NOT have additional properties' + if (error.instancePath === '' && error.keyword === 'additionalProperties') { + return `${resourceSchema.resourceName} does not include property '${error.params.additionalProperty}'`; + } + return `${error.instancePath} ${error.message}` ?? ''; + }); + + errors = [...errors, ...ajvErrors]; + } + + return errors; +} + +/** + * Validates that the query string keys are actually fields on the API resource. */ export async function validateQueryString( queryStrings: FrontendQueryParameters, - matchingMetaEdModel: TopLevelEntity, + resourceSchema: ResourceSchema, ): Promise { - const bodyValidation: string[] = validateQueryParametersAgainstSchema(matchingMetaEdModel, queryStrings); + const bodyValidation: string[] = validateQueryParameters(resourceSchema, queryStrings); if (bodyValidation.length > 0) { const modelState = Object.assign({}, ...bodyValidation.map((x) => ({ [x]: 'Invalid property' }))); return { diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceSchemaValidation.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceSchemaValidation.ts new file mode 100644 index 00000000..08fe292b --- /dev/null +++ b/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceSchemaValidation.ts @@ -0,0 +1,50 @@ +// SPDX-License-Identifier: Apache-2.0 +// Licensed to the Ed-Fi Alliance under one or more agreements. +// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. +// See the LICENSE and NOTICES files in the project root for more information. + +import Ajv from 'ajv/dist/2020'; +import addFormatsTo from 'ajv-formats'; +import type { ValidateFunction } from 'ajv'; +import { getBooleanFromEnvironment } from '@edfi/meadowlark-utilities'; +import { ResourceSchema } from '../model/api-schema/ResourceSchema'; + +/** + * Compiled ajv JSON Schema validator functions for the API resource + */ +export type ResourceSchemaValidators = { + insertValidator: ValidateFunction; + queryValidator: ValidateFunction; + updateValidator: ValidateFunction; +}; + +function initializeAjv(): Ajv { + const coerceTypes = getBooleanFromEnvironment('ALLOW_TYPE_COERCION', false); + + const ajv = new Ajv({ allErrors: true, coerceTypes }); + addFormatsTo(ajv); + + return ajv; +} + +const ajv = initializeAjv(); + +// simple cache implementation, see: https://rewind.io/blog/simple-caching-in-aws-lambda-functions/ +/** This is a cache mapping MetaEd model objects to compiled ajv JSON Schema validators for the API resource */ +const validatorCache: Map = new Map(); + +/** + * Returns the API resource JSON Schema validator functions for the given ResourceSchema. Caches results. + */ +export function getSchemaValidatorsFor(resourceSchema: ResourceSchema): ResourceSchemaValidators { + const cachedValidators: ResourceSchemaValidators | undefined = validatorCache.get(resourceSchema); + if (cachedValidators != null) return cachedValidators; + + const resourceValidators: ResourceSchemaValidators = { + insertValidator: ajv.compile(resourceSchema.jsonSchemaForInsert), + queryValidator: ajv.compile(resourceSchema.jsonSchemaForQuery), + updateValidator: ajv.compile(resourceSchema.jsonSchemaForUpdate), + }; + validatorCache.set(resourceSchema, resourceValidators); + return resourceValidators; +} diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceValidator.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceValidator.ts deleted file mode 100644 index 757eef02..00000000 --- a/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceValidator.ts +++ /dev/null @@ -1,92 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import { normalizeDescriptorSuffix } from '@edfi/metaed-core'; -import { loadMetaEdState } from '../metaed/LoadMetaEd'; -import { modelPackageFor } from '../metaed/MetaEdProjectMetadata'; -import { matchResourceNameToMetaEd } from '../metaed/MetaEdValidation'; -import { decapitalize } from '../Utility'; -import { PathComponents } from '../model/PathComponents'; -import { NoResourceInfo, ResourceInfo } from '../model/ResourceInfo'; - -export type ResourceValidationResult = { - /** - * The name of the validated endpoint, corresponding to the name of the resource requested - */ - resourceName: string; - /** - * Metadata for the MetaEd project loaded - */ - headerMetadata?: any; - /** - * Error message for validation failure - */ - errorBody?: {}; - /** - * Information on the validated MetaEd entity matching the API request - */ - resourceInfo: ResourceInfo; -}; - -/** - * Dynamically performs validation of a request against a resource. - * - * Starts by loading the MetaEd project specified in the endpoint path. Then uses the MetaEd internal - * model, enriched by Meadowlark-specific enhancers, to validate the complete resource endpoint path. - */ -export async function validateResource(pathComponents: PathComponents): Promise { - // Equally supporting resources with either upper or lower case names - const lowerResourceName = decapitalize(pathComponents.resourceName); - - const modelNpmPackage = modelPackageFor(pathComponents.version); - const { metaEd, metaEdConfiguration } = await loadMetaEdState(modelNpmPackage); - - const { resourceName, isDescriptor, exact, suggestion, matchingMetaEdModel } = matchResourceNameToMetaEd( - lowerResourceName, - metaEd, - pathComponents.namespace, - ); - const headerMetadata: object = { - 'X-MetaEd-Project-Name': metaEdConfiguration.projects[0].projectName, - 'X-MetaEd-Project-Version': metaEdConfiguration.projects[0].projectVersion, - 'X-MetaEd-Project-Package-Name': modelNpmPackage, - }; - - if (exact === false && suggestion === true) { - const invalidResourceMessage = `Invalid resource '${pathComponents.resourceName}'. The most similar resource is '${resourceName}'.`; - - return { - headerMetadata, - resourceName: pathComponents.resourceName, - resourceInfo: NoResourceInfo, - errorBody: { - error: invalidResourceMessage, - }, - }; - } - - if (exact === false && suggestion === false) { - return { - headerMetadata, - resourceName: pathComponents.resourceName, - resourceInfo: NoResourceInfo, - errorBody: { error: `Invalid resource '${pathComponents.resourceName}'.` }, - }; - } - - return { - headerMetadata, - resourceName: pathComponents.resourceName, - resourceInfo: { - projectName: metaEdConfiguration.projects[0].projectName, - resourceVersion: metaEdConfiguration.projects[0].projectVersion, - resourceName: isDescriptor - ? normalizeDescriptorSuffix(matchingMetaEdModel.metaEdName) - : matchingMetaEdModel.metaEdName, - isDescriptor, - allowIdentityUpdates: matchingMetaEdModel.allowPrimaryKeyUpdates, - }, - }; -} diff --git a/Meadowlark-js/packages/meadowlark-core/test/handler/DeleteIt.test.ts b/Meadowlark-js/packages/meadowlark-core/test/handler/DeleteIt.test.ts index 49a7ca3e..06d623a4 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/handler/DeleteIt.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/handler/DeleteIt.test.ts @@ -10,15 +10,18 @@ import { FrontendRequest, newFrontendRequest, newFrontendRequestMiddleware } fro import { NoDocumentStorePlugin } from '../../src/plugin/backend/NoDocumentStorePlugin'; import { ReferringDocumentInfo } from '../../src/message/ReferringDocumentInfo'; import { DocumentUuid, MeadowlarkId } from '../../src/model/IdTypes'; +import { EndpointName } from '../../src/model/api-schema/EndpointName'; +import { ProjectNamespace } from '../../src/model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../../src/model/ProjectShortVersion'; const frontendRequest: FrontendRequest = { ...newFrontendRequest(), middleware: { ...newFrontendRequestMiddleware(), pathComponents: { - resourceName: 'academicWeeks', - namespace: 'ed-fi', - version: 'v3.3b', + endpointName: 'academicWeeks' as EndpointName, + projectNamespace: 'ed-fi' as ProjectNamespace, + projectShortVersion: 'v3.3b' as ProjectShortVersion, documentUuid: '2edb604f-eab0-412c-a242-508d6529214d' as DocumentUuid, }, }, diff --git a/Meadowlark-js/packages/meadowlark-core/test/handler/GetById.test.ts b/Meadowlark-js/packages/meadowlark-core/test/handler/GetById.test.ts index 159eaf70..55d7e555 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/handler/GetById.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/handler/GetById.test.ts @@ -11,11 +11,14 @@ import { PathComponents } from '../../src/model/PathComponents'; import * as PluginLoader from '../../src/plugin/PluginLoader'; import { NoDocumentStorePlugin } from '../../src/plugin/backend/NoDocumentStorePlugin'; import { DocumentUuid } from '../../src/model/IdTypes'; +import { EndpointName } from '../../src/model/api-schema/EndpointName'; +import { ProjectNamespace } from '../../src/model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../../src/model/ProjectShortVersion'; const validPathComponents: PathComponents = { - resourceName: '1', - namespace: '2', - version: '3', + endpointName: '1' as EndpointName, + projectNamespace: '2' as ProjectNamespace, + projectShortVersion: '3' as ProjectShortVersion, documentUuid: '6b4e03423667dbb73b6e15454f0eb1abd4597f9a1b078e3f5b5a6bc7' as DocumentUuid, }; diff --git a/Meadowlark-js/packages/meadowlark-core/test/handler/Query.test.ts b/Meadowlark-js/packages/meadowlark-core/test/handler/Query.test.ts index c9dd845e..7096779a 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/handler/Query.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/handler/Query.test.ts @@ -9,6 +9,9 @@ import * as PluginLoader from '../../src/plugin/PluginLoader'; import { FrontendResponse } from '../../src/handler/FrontendResponse'; import { FrontendRequest, newFrontendRequest, newFrontendRequestMiddleware } from '../../src/handler/FrontendRequest'; import { NoDocumentStorePlugin } from '../../src/plugin/backend/NoDocumentStorePlugin'; +import { EndpointName } from '../../src/model/api-schema/EndpointName'; +import { ProjectNamespace } from '../../src/model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../../src/model/ProjectShortVersion'; const frontendRequest: FrontendRequest = { ...newFrontendRequest(), @@ -16,9 +19,9 @@ const frontendRequest: FrontendRequest = { middleware: { ...newFrontendRequestMiddleware(), pathComponents: { - resourceName: 'academicWeeks', - namespace: 'ed-fi', - version: 'v3.3b', + endpointName: 'academicWeeks' as EndpointName, + projectNamespace: 'ed-fi' as ProjectNamespace, + projectShortVersion: 'v3.3b' as ProjectShortVersion, }, }, }; diff --git a/Meadowlark-js/packages/meadowlark-core/test/handler/Update.test.ts b/Meadowlark-js/packages/meadowlark-core/test/handler/Update.test.ts index fd88ca21..f284287b 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/handler/Update.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/handler/Update.test.ts @@ -10,6 +10,9 @@ import { FrontendRequest, newFrontendRequest, newFrontendRequestMiddleware } fro import { NoDocumentStorePlugin } from '../../src/plugin/backend/NoDocumentStorePlugin'; import { ReferringDocumentInfo } from '../../src/message/ReferringDocumentInfo'; import { DocumentUuid, MeadowlarkId } from '../../src/model/IdTypes'; +import { EndpointName } from '../../src/model/api-schema/EndpointName'; +import { ProjectNamespace } from '../../src/model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../../src/model/ProjectShortVersion'; const documentUuid = '2edb604f-eab0-412c-a242-508d6529214d' as DocumentUuid; const frontendRequest: FrontendRequest = { @@ -18,9 +21,9 @@ const frontendRequest: FrontendRequest = { middleware: { ...newFrontendRequestMiddleware(), pathComponents: { - resourceName: 'academicWeeks', - namespace: 'ed-fi', - version: 'v3.3b', + endpointName: 'academicWeeks' as EndpointName, + projectNamespace: 'ed-fi' as ProjectNamespace, + projectShortVersion: 'v3.3b' as ProjectShortVersion, documentUuid, }, }, diff --git a/Meadowlark-js/packages/meadowlark-core/test/handler/Upsert.test.ts b/Meadowlark-js/packages/meadowlark-core/test/handler/Upsert.test.ts index 953760db..5314b6a7 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/handler/Upsert.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/handler/Upsert.test.ts @@ -12,6 +12,9 @@ import { NoDocumentStorePlugin } from '../../src/plugin/backend/NoDocumentStoreP import { ReferringDocumentInfo } from '../../src/message/ReferringDocumentInfo'; import { isDocumentUuidWellFormed } from '../../src/model/DocumentIdentity'; import { DocumentUuid, MeadowlarkId } from '../../src/model/IdTypes'; +import { EndpointName } from '../../src/model/api-schema/EndpointName'; +import { ProjectNamespace } from '../../src/model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../../src/model/ProjectShortVersion'; const documentUuid = '3218d452-a7b7-4f1c-aa91-26ccc48cf4b8' as DocumentUuid; const frontendRequest: FrontendRequest = { @@ -20,9 +23,9 @@ const frontendRequest: FrontendRequest = { middleware: { ...newFrontendRequestMiddleware(), pathComponents: { - resourceName: 'academicWeeks', - namespace: 'ed-fi', - version: 'v3.3b', + endpointName: 'academicWeeks' as EndpointName, + projectNamespace: 'ed-fi' as ProjectNamespace, + projectShortVersion: 'v3.3b' as ProjectShortVersion, }, }, }; diff --git a/Meadowlark-js/packages/meadowlark-core/test/metaed/ResourceNameMapping.test.ts b/Meadowlark-js/packages/meadowlark-core/test/metaed/ResourceNameMapping.test.ts deleted file mode 100644 index 10d24aec..00000000 --- a/Meadowlark-js/packages/meadowlark-core/test/metaed/ResourceNameMapping.test.ts +++ /dev/null @@ -1,271 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import { - newMetaEdEnvironment, - MetaEdEnvironment, - DomainEntityBuilder, - MetaEdTextBuilder, - NamespaceBuilder, - DomainEntitySubclassBuilder, - AssociationBuilder, - AssociationSubclassBuilder, - DescriptorBuilder, -} from '@edfi/metaed-core'; -import { getMetaEdModelForResourceName, resetCache } from '../../src/metaed/ResourceNameMapping'; - -describe('when looking for a domain entity model matching a resource name', () => { - const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); - const namespace = 'EdFi'; - - beforeAll(() => { - MetaEdTextBuilder.build() - .withBeginNamespace(namespace) - .withStartDomainEntity('Section') - .withDocumentation('doc') - .withStringIdentity('SectionIdentifier', 'doc', '30') - .withEndDomainEntity() - .withEndNamespace() - - .sendToListener(new NamespaceBuilder(metaEd, [])) - .sendToListener(new DomainEntityBuilder(metaEd, [])); - }); - - describe('and given upper case resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('Sections', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given lower case resource name', () => { - it('returns true', () => { - expect(getMetaEdModelForResourceName('sections', metaEd, namespace)).toBeDefined(); - }); - }); - - describe('and given non-pluralized resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('section', metaEd, namespace)).not.toBeDefined(); - }); - }); -}); - -describe('when looking for a domain entity subclass model matching a resource name', () => { - const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); - const namespace = 'EdFi'; - - beforeAll(() => { - resetCache(); - MetaEdTextBuilder.build() - .withBeginNamespace(namespace) - .withStartDomainEntity('EducationOrganization') - .withDocumentation('doc') - .withIntegerIdentity('EducationOrganizationId', 'doc') - .withEndDomainEntity() - - .withStartDomainEntitySubclass('School', 'EducationOrganization') - .withIntegerIdentity('SchoolId', 'doc') - .withEndDomainEntitySubclass() - .withEndNamespace() - - .sendToListener(new NamespaceBuilder(metaEd, [])) - .sendToListener(new DomainEntityBuilder(metaEd, [])) - .sendToListener(new DomainEntitySubclassBuilder(metaEd, [])); - }); - - describe('and given upper case resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('Schools', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given lower case resource name', () => { - it('returns true', () => { - expect(getMetaEdModelForResourceName('schools', metaEd, namespace)).toBeDefined(); - }); - }); - - describe('and given non-pluralized resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('school', metaEd, namespace)).not.toBeDefined(); - }); - }); -}); - -describe('when looking for a non-GeneralStudentProgramAssociation association model matching a resource name', () => { - const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); - const namespace = 'EdFi'; - - beforeAll(() => { - resetCache(); - MetaEdTextBuilder.build() - .withBeginNamespace(namespace) - .withStartAssociation('SectionAssociation') - .withDocumentation('doc') - .withStringIdentity('SectionIdentifier', 'doc', '30') - .withEndAssociation() - - .sendToListener(new NamespaceBuilder(metaEd, [])) - .sendToListener(new AssociationBuilder(metaEd, [])); - }); - - describe('and given upper case resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('SectionAssociations', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given lower case resource name', () => { - it('returns true', () => { - expect(getMetaEdModelForResourceName('sectionAssociations', metaEd, namespace)).toBeDefined(); - }); - }); - - describe('and given non-pluralized resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('sectionAssociation', metaEd, namespace)).not.toBeDefined(); - }); - }); -}); - -describe('when looking for the GeneralStudentProgramAssociation model matching a resource name', () => { - const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); - const namespace = 'EdFi'; - - beforeAll(() => { - resetCache(); - MetaEdTextBuilder.build() - .withBeginNamespace(namespace) - .withStartAssociation('GeneralStudentProgramAssociation') - .withDocumentation('doc') - .withIntegerIdentity('EducationOrganizationId', 'doc') - .withEndAssociation() - - .sendToListener(new NamespaceBuilder(metaEd, [])) - .sendToListener(new AssociationBuilder(metaEd, [])); - }); - - describe('and given upper case resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('GeneralStudentProgramAssociations', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given lower case resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('generalStudentProgramAssociations', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given non-pluralized resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('generalStudentProgramAssociation', metaEd, namespace)).not.toBeDefined(); - }); - }); -}); - -describe('when looking for an association subclass model matching a resource name', () => { - const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); - const namespace = 'EdFi'; - - beforeAll(() => { - resetCache(); - MetaEdTextBuilder.build() - .withBeginNamespace(namespace) - .withStartAssociation('GeneralStudentProgramAssociation') - .withDocumentation('doc') - .withIntegerIdentity('EducationOrganizationId', 'doc') - .withEndAssociation() - - .withStartAssociationSubclass('StudentProgramAssociation', 'GeneralStudentProgramAssociation') - .withDocumentation('doc') - .withIntegerIdentity('Service', 'doc') - .withEndAssociationSubclass() - - .sendToListener(new NamespaceBuilder(metaEd, [])) - .sendToListener(new AssociationBuilder(metaEd, [])) - .sendToListener(new AssociationSubclassBuilder(metaEd, [])); - }); - - describe('and given upper case resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('StudentProgramAssociations', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given lower case resource name', () => { - it('returns true', () => { - expect(getMetaEdModelForResourceName('studentProgramAssociations', metaEd, namespace)).toBeDefined(); - }); - }); - - describe('and given non-pluralized resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('studentProgramAssociation', metaEd, namespace)).not.toBeDefined(); - }); - }); -}); - -describe('when looking for a descriptor model matching a resource name', () => { - const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); - const namespace = 'EdFi'; - - beforeAll(() => { - resetCache(); - MetaEdTextBuilder.build() - .withBeginNamespace(namespace) - .withStartDescriptor('GradeLevel') - .withDocumentation('doc') - .withEndDescriptor() - - .sendToListener(new NamespaceBuilder(metaEd, [])) - .sendToListener(new DescriptorBuilder(metaEd, [])); - }); - - describe('and given upper case resource name without "Descriptor" suffix', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('GradeLevels', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given lower case resource name without "Descriptor" suffix', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('gradeLevels', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given upper case resource name with "Descriptor" suffix', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('GradeLevelDescriptors', metaEd, namespace)).not.toBeDefined(); - }); - }); - - describe('and given lower case resource name with "Descriptor" suffix', () => { - it('returns true', () => { - expect(getMetaEdModelForResourceName('gradeLevelDescriptors', metaEd, namespace)).toBeDefined(); - }); - }); - - describe('and given non-pluralized resource name', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('gradeLevelDescriptor', metaEd, namespace)).not.toBeDefined(); - }); - }); -}); - -describe('when looking for a non-existant model matching a resource name', () => { - const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); - const namespace = 'EdFi'; - - beforeAll(() => { - resetCache(); - }); - - describe('given entity does not exist', () => { - it('returns false', () => { - expect(getMetaEdModelForResourceName('DoesNotExist', metaEd, namespace)).not.toBeDefined(); - }); - }); -}); diff --git a/Meadowlark-js/packages/meadowlark-core/test/middleware/FindMetaEdModelMiddleware.test.ts b/Meadowlark-js/packages/meadowlark-core/test/middleware/FindMetaEdModelMiddleware.test.ts deleted file mode 100644 index 9d0faea5..00000000 --- a/Meadowlark-js/packages/meadowlark-core/test/middleware/FindMetaEdModelMiddleware.test.ts +++ /dev/null @@ -1,107 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import { newTopLevelEntity, TopLevelEntity } from '@edfi/metaed-core'; -import * as MetaEdModelFinder from '../../src/metaed/MetaEdModelFinder'; -import { metaEdModelFinding } from '../../src/middleware/FindMetaEdModelMiddleware'; -import { FrontendResponse, newFrontendResponse } from '../../src/handler/FrontendResponse'; -import { FrontendRequest, newFrontendRequest } from '../../src/handler/FrontendRequest'; -import { MiddlewareModel } from '../../src/middleware/MiddlewareModel'; - -describe('given a previous middleware has created a response', () => { - const frontendRequest: FrontendRequest = newFrontendRequest(); - const frontendResponse: FrontendResponse = newFrontendResponse(); - let resultChain: MiddlewareModel; - let mockDocumentValidator: any; - - beforeAll(async () => { - mockDocumentValidator = jest.spyOn(MetaEdModelFinder, 'findMetaEdModel'); - - // Act - resultChain = await metaEdModelFinding({ frontendRequest, frontendResponse }); - }); - - afterAll(() => { - mockDocumentValidator.mockRestore(); - }); - - it('returns the given request', () => { - expect(resultChain.frontendRequest).toBe(frontendRequest); - }); - - it('returns the given response', () => { - expect(resultChain.frontendResponse).toBe(frontendResponse); - }); - - it('never calls metaEdModelFinding', () => { - expect(mockDocumentValidator).not.toHaveBeenCalled(); - }); -}); - -describe('given a no match response from findMetaEdModel', () => { - const frontendRequest: FrontendRequest = newFrontendRequest(); - let resultChain: MiddlewareModel; - let mockDocumentValidator: any; - - beforeAll(async () => { - mockDocumentValidator = jest.spyOn(MetaEdModelFinder, 'findMetaEdModel').mockReturnValue(Promise.resolve(undefined)); - - // Act - resultChain = await metaEdModelFinding({ frontendRequest, frontendResponse: null }); - }); - - afterAll(() => { - mockDocumentValidator.mockRestore(); - }); - - it('returns the given request', () => { - expect(resultChain.frontendRequest).toBe(frontendRequest); - }); - - it('returns status 500', () => { - expect(resultChain.frontendResponse?.statusCode).toEqual(500); - }); - - it('returns an empty body', () => { - expect(resultChain.frontendResponse?.body).toBeUndefined(); - }); -}); - -describe('given a match response from findMetaEdModel', () => { - const frontendRequest: FrontendRequest = newFrontendRequest(); - const topLevelEntity: TopLevelEntity = newTopLevelEntity(); - const headerMetadata = {}; - let resultChain: MiddlewareModel; - let mockDocumentValidator: any; - - beforeAll(async () => { - mockDocumentValidator = jest - .spyOn(MetaEdModelFinder, 'findMetaEdModel') - .mockReturnValue(Promise.resolve(topLevelEntity)); - - // Act - resultChain = await metaEdModelFinding({ frontendRequest, frontendResponse: null }); - }); - - afterAll(() => { - mockDocumentValidator.mockRestore(); - }); - - it('returns the given request', () => { - expect(resultChain.frontendRequest).toBe(frontendRequest); - }); - - it('adds matchingMetaEdModel to frontendRequest', () => { - expect(resultChain.frontendRequest.middleware.matchingMetaEdModel).toBe(topLevelEntity); - }); - - it('adds headerMetadata to frontendRequest', () => { - expect(resultChain.frontendRequest.middleware.headerMetadata).toEqual(headerMetadata); - }); - - it('does not create a response', () => { - expect(resultChain.frontendResponse).toBeNull(); - }); -}); diff --git a/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateDocumentMiddleware.test.ts b/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateDocumentMiddleware.test.ts index 3ff2228d..82fedf52 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateDocumentMiddleware.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateDocumentMiddleware.test.ts @@ -58,9 +58,7 @@ describe('given an error response and document info from documentValidation', () beforeAll(async () => { const validationResult = { error: errorBody }; - mockDocumentValidator = jest - .spyOn(DocumentValidator, 'validateDocument') - .mockReturnValue(Promise.resolve(validationResult)); + mockDocumentValidator = jest.spyOn(DocumentValidator, 'validateDocument').mockReturnValue(validationResult); // Act resultChain = await documentValidation({ frontendRequest, frontendResponse: null }); diff --git a/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateResourceMiddleware.test.ts b/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateEndpointMiddleware.test.ts similarity index 77% rename from Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateResourceMiddleware.test.ts rename to Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateEndpointMiddleware.test.ts index e636be4e..c2dc9c46 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateResourceMiddleware.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/middleware/ValidateEndpointMiddleware.test.ts @@ -3,13 +3,18 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import * as ResourceValidator from '../../src/validation/ResourceValidator'; -import { resourceValidation } from '../../src/middleware/ValidateResourceMiddleware'; +import * as EndpointValidator from '../../src/validation/EndpointValidator'; +import { endpointValidation } from '../../src/middleware/ValidateEndpointMiddleware'; import { FrontendResponse, newFrontendResponse } from '../../src/handler/FrontendResponse'; import { FrontendRequest, newFrontendRequest, newFrontendRequestMiddleware } from '../../src/handler/FrontendRequest'; import { newResourceInfo, NoResourceInfo } from '../../src/model/ResourceInfo'; import { MiddlewareModel } from '../../src/middleware/MiddlewareModel'; import { DocumentUuid } from '../../src/model/IdTypes'; +import { EndpointValidationResult } from '../../src/validation/EndpointValidationResult'; +import { NoResourceSchema } from '../../src/model/api-schema/ResourceSchema'; +import { EndpointName } from '../../src/model/api-schema/EndpointName'; +import { ProjectNamespace } from '../../src/model/api-schema/ProjectNamespace'; +import { ProjectShortVersion } from '../../src/model/ProjectShortVersion'; describe('given a previous middleware has created a response', () => { const frontendRequest: FrontendRequest = newFrontendRequest(); @@ -18,10 +23,10 @@ describe('given a previous middleware has created a response', () => { let mockResourceValidator: any; beforeAll(async () => { - mockResourceValidator = jest.spyOn(ResourceValidator, 'validateResource'); + mockResourceValidator = jest.spyOn(EndpointValidator, 'validateEndpoint'); // Act - resultChain = await resourceValidation({ frontendRequest, frontendResponse }); + resultChain = await endpointValidation({ frontendRequest, frontendResponse }); }); afterAll(() => { @@ -48,18 +53,18 @@ describe('given an error response and no document info from resourceValidation', let mockResourceValidator: any; beforeAll(async () => { - const validationResult: ResourceValidator.ResourceValidationResult = { + const validationResult: EndpointValidationResult = { resourceInfo: NoResourceInfo, errorBody, - resourceName: '', + resourceSchema: NoResourceSchema, }; mockResourceValidator = jest - .spyOn(ResourceValidator, 'validateResource') + .spyOn(EndpointValidator, 'validateEndpoint') .mockReturnValue(Promise.resolve(validationResult)); // Act - resultChain = await resourceValidation({ frontendRequest, frontendResponse: null }); + resultChain = await endpointValidation({ frontendRequest, frontendResponse: null }); }); afterAll(() => { @@ -86,18 +91,18 @@ describe('given an error response and document info from resourceValidation', () let mockResourceValidator: any; beforeAll(async () => { - const validationResult: ResourceValidator.ResourceValidationResult = { + const validationResult: EndpointValidationResult = { resourceInfo: newResourceInfo(), errorBody, - resourceName: '', + resourceSchema: NoResourceSchema, }; mockResourceValidator = jest - .spyOn(ResourceValidator, 'validateResource') + .spyOn(EndpointValidator, 'validateEndpoint') .mockReturnValue(Promise.resolve(validationResult)); // Act - resultChain = await resourceValidation({ frontendRequest, frontendResponse: null }); + resultChain = await endpointValidation({ frontendRequest, frontendResponse: null }); }); afterAll(() => { @@ -125,18 +130,18 @@ describe('given a valid response from resourceValidation', () => { let mockResourceValidator: any; beforeAll(async () => { - const validationResult: ResourceValidator.ResourceValidationResult = { + const validationResult: EndpointValidationResult = { resourceInfo, - resourceName: '', + resourceSchema: NoResourceSchema, headerMetadata, }; mockResourceValidator = jest - .spyOn(ResourceValidator, 'validateResource') + .spyOn(EndpointValidator, 'validateEndpoint') .mockReturnValue(Promise.resolve(validationResult)); // Act - resultChain = await resourceValidation({ frontendRequest, frontendResponse: null }); + resultChain = await endpointValidation({ frontendRequest, frontendResponse: null }); }); afterAll(() => { @@ -171,16 +176,16 @@ describe('given requesting abstract domain entity', () => { middleware: { ...newFrontendRequestMiddleware(), pathComponents: { - resourceName: 'educationOrganizations', - namespace: 'ed-fi', - version: 'v3.3b', + endpointName: 'educationOrganizations' as EndpointName, + projectNamespace: 'ed-fi' as ProjectNamespace, + projectShortVersion: 'v3.3b' as ProjectShortVersion, documentUuid: 'db4f71a9-30dd-407a-ace4-07a056f781a3' as DocumentUuid, }, }, }; // Act - resultChain = await resourceValidation({ frontendRequest, frontendResponse: null }); + resultChain = await endpointValidation({ frontendRequest, frontendResponse: null }); }); it('returns status 404', () => { @@ -207,16 +212,16 @@ describe('given requesting abstract association', () => { middleware: { ...newFrontendRequestMiddleware(), pathComponents: { - resourceName: 'generalStudentProgramAssociations', - namespace: 'ed-fi', - version: 'v3.3b', + endpointName: 'generalStudentProgramAssociations' as EndpointName, + projectNamespace: 'ed-fi' as ProjectNamespace, + projectShortVersion: 'v3.3b' as ProjectShortVersion, documentUuid: 'df4f71a9-30dd-407a-ace4-07a056f781a3' as DocumentUuid, }, }, }; // Act - resultChain = await resourceValidation({ frontendRequest, frontendResponse: null }); + resultChain = await endpointValidation({ frontendRequest, frontendResponse: null }); }); it('returns status 404', () => { diff --git a/Meadowlark-js/packages/meadowlark-core/test/validation/DocumentValidator.test.ts b/Meadowlark-js/packages/meadowlark-core/test/validation/DocumentValidator.test.ts deleted file mode 100644 index 3681b847..00000000 --- a/Meadowlark-js/packages/meadowlark-core/test/validation/DocumentValidator.test.ts +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Licensed to the Ed-Fi Alliance under one or more agreements. -// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. -// See the LICENSE and NOTICES files in the project root for more information. - -import { ValidationError } from '@apideck/better-ajv-errors'; -import { newDomainEntity, newTopLevelEntity } from '@edfi/metaed-core'; -import { validateDocument } from '../../src/validation/DocumentValidator'; -import * as LoadMetaEd from '../../src/metaed/LoadMetaEd'; -import * as MetaEdValidation from '../../src/metaed/MetaEdValidation'; -import * as ResourceNameMapping from '../../src/metaed/ResourceNameMapping'; - -describe('given a valid resource name but body fails schema validation', () => { - let result: object | null; - let mockValidateBodyAgainstSchema: any; - let mockLoadMetaEdState: any; - let mockMatchEndpointToMetaEd: any; - const validationError: ValidationError = { - message: '_message', - path: '_path', - context: { errorType: 'required' }, - }; - - beforeAll(async () => { - mockValidateBodyAgainstSchema = jest - .spyOn(MetaEdValidation, 'validateEntityBodyAgainstSchema') - .mockReturnValue([validationError]); - - mockLoadMetaEdState = jest.spyOn(LoadMetaEd, 'loadMetaEdState').mockReturnValue( - Promise.resolve({ - metaEd: {}, - metaEdConfiguration: { projects: [{}] }, - } as any), - ); - - mockMatchEndpointToMetaEd = jest.spyOn(ResourceNameMapping, 'getMetaEdModelForResourceName').mockReturnValue({ - ...newDomainEntity(), - metaEdName: 'DomainEntityName', - data: { meadowlark: { apiMapping: { assignableTo: null } } }, - } as any); - - // Act - result = await validateDocument( - { version: 'a', namespace: 'b', resourceName: 'match', resourceId: null }, - newTopLevelEntity(), - ); - }); - - afterAll(() => { - mockValidateBodyAgainstSchema.mockRestore(); - mockLoadMetaEdState.mockRestore(); - mockMatchEndpointToMetaEd.mockRestore(); - }); - - it('returns an error message', () => { - expect(result).toMatchInlineSnapshot(` - { - "error": [ - { - "context": { - "errorType": "required", - }, - "message": "_message", - "path": "_path", - }, - ], - } - `); - }); -}); diff --git a/Meadowlark-js/packages/meadowlark-core/test/validation/EqualityConstraintValidator.test.ts b/Meadowlark-js/packages/meadowlark-core/test/validation/EqualityConstraintValidator.test.ts index 10da36a0..436ce0df 100644 --- a/Meadowlark-js/packages/meadowlark-core/test/validation/EqualityConstraintValidator.test.ts +++ b/Meadowlark-js/packages/meadowlark-core/test/validation/EqualityConstraintValidator.test.ts @@ -20,7 +20,7 @@ import { referenceComponentEnhancer, apiPropertyMappingEnhancer, propertyCollectingEnhancer, - jsonPathsMappingEnhancer, + allJsonPathsMappingEnhancer, equalityConstraintEnhancer, } from '@edfi/metaed-plugin-edfi-api-schema'; import { validateEqualityConstraints } from '../../src/validation/EqualityConstraintValidator'; diff --git a/Meadowlark-js/tests/e2e/setup/SetupTestEnvironment.ts b/Meadowlark-js/tests/e2e/setup/SetupTestEnvironment.ts index c353fb61..012ccff2 100644 --- a/Meadowlark-js/tests/e2e/setup/SetupTestEnvironment.ts +++ b/Meadowlark-js/tests/e2e/setup/SetupTestEnvironment.ts @@ -7,8 +7,8 @@ const { join } = require('path'); const dotenv = require('dotenv'); const credentials = require('../helpers/Credentials'); -// @ts-ignore -const environment = require('./SetupTestContainers'); + +const setupContainers = require('./SetupTestContainers'); if (process.env.USE_EXISTING_ENVIRONMENT) { dotenv.config({ path: join(process.cwd(), './services/meadowlark-fastify/.env') }); @@ -26,7 +26,7 @@ module.exports = async () => { if (process.env.USE_EXISTING_ENVIRONMENT) { console.info('Using existing environment, Verify that variables are set'); } else { - await environment.configure(initialize); + await setupContainers.configure(initialize); } process.env.ROOT_URL = `http://localhost:${process.env.FASTIFY_PORT ?? 3001}`; diff --git a/Meadowlark-js/tests/e2e/setup/TeardownTestEnvironment.ts b/Meadowlark-js/tests/e2e/setup/TeardownTestEnvironment.ts index 1a10d089..c7a805ad 100644 --- a/Meadowlark-js/tests/e2e/setup/TeardownTestEnvironment.ts +++ b/Meadowlark-js/tests/e2e/setup/TeardownTestEnvironment.ts @@ -3,13 +3,12 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -// @ts-ignore -const environment = require('./SetupTestContainers'); +const setupTestContainers = require('./SetupTestContainers'); async function endServer() { try { if (!process.env.DEVELOPER_MODE && !process.env.USE_EXISTING_ENVIRONMENT) { - await environment.stop(); + await setupTestContainers.stop(); } } catch (error) { console.info(error);